Loading ...

REST API: Add Role | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: User Roles » REST API: Add Role
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 40

REST API: Add Role

0 
 /5
0 (0votes)
Open API Guide
POST/api/roles

Add a new top level role

ImportantThis endpoint creates roles at the top level community. See REST API: Add Space Role to create a space-level role.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
Role JSONStringYESBodyThis is JSON that represents a role object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below
DescriptionStringYESBodyHuman-readable description explaining what permissions or access this role grants
RoleNameStringYESBodyDisplay name for the role. Must be unique within its scope (site-level or space-level).

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/roles

Request Body

{
    "Description":"A person whose job is to test something, especially a new product.",
    "RoleName": "Tester"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": true,
  "ResponseData": 61
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required field missing",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (role)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages