Loading ...

REST API: Delete Persona | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Personas » REST API: Delete Persona
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Delete Persona

0 
 /5
0 (0votes)
Open API Guide
DELETE/api/personas/{PersonaID}

Deletes a persona, or, when a SpaceID is sent, removes only the persona's action that adds people to that space.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
PersonaIDIntegerYESPathUnique identifier for a specific Persona

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOQueryWhen sent, only this persona's action that adds people to that space is removed, and the persona is kept. The call answers false if the persona has no such action. The caller needs permission to manage personas for that space. When left out, or when the value is not a number, the whole persona is deleted. Site-level persona permission is then checked.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/personas/123

Success Response

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

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestPersonaID in the path is not an integer.Send the persona's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller passed the persona permission check but is not a site administrator. Also, either the PersonaSpaceAdminAccess property is off, or SpaceID was sent and the caller is not an administrator of that space. The body is empty.Confirm the user has the required roles for this action.
405 Method Not AllowedNo PersonaID in the path, so no delete action matches the request.Add the persona's ID to the path.
500 Server ErrorInternal failure.Retry later.
200 with a permission messageThe caller cannot manage personas at that level: ResponseMessage says the user lacks sufficient permission, IsError stays false, ResponseData is true, and nothing is deleted.Read ResponseMessage as well as IsError; call with a token that can manage personas for the space or the site.
200 with ResponseData falseNo persona with that ID, or, with SpaceID, the persona has no action for that space.Check PersonaID and SpaceID.

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