Loading ...

REST API: Add Space Role | Axero Documentation

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

REST API: Add Space Role

0 
 /5
0 (0votes)
Open API Guide
POST/api/spaces/{SpaceID}/roles

Adds a new role to the space

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).
SpaceIDIntegerYESPathUnique identifier for a particular space

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
    "Description":"A person who's job is to tests something, especially a new product.",
    "RoleName": "Tester"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "True",
  "ResponseData": 1971
}

Error Response

HTTP 500 with an empty body

Error Handling

Status CodeLikely CauseNext Action
500 Server ErrorA required parameter is missing. The endpoint fails with an empty body instead of reporting the missing value.Verify the request against the required parameters before treating the 500 as a server fault.
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.

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