Loading ...

REST API: Update Persona | Axero Documentation

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

REST API: Update Persona

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

Updates a persona and replaces its conditions and actions with the ones in the body. A condition or action left out, or sent without its ID, is deleted. ResponseData is the saved persona, and ResponseMessage reads the site's changes-saved text. Failures answer 200 with IsError true, and ResponseMessage gives the reason. It carries the permission text when the caller can manage neither site personas nor the one space the actions target, and a name-required message when the name is missing. Any other failure carries the generic action-failed text. A body the endpoint cannot use answers 500 with an empty body instead; see Error Handling.

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
NameStringYESBodyName of the persona. The endpoint refuses an empty name with Please enter a valid name. A JSON list instead of text answers 500 with an empty body, and nothing is saved.
PersonaIDIntegerYESPathID of the persona to update

Optional Parameters

ParameterTypeRequiredLocationDescription
IsEnabledBooleanNOBodyWhether the persona is active. Leaving it out sets it to false. So does a value that is not true or false, such as text.
IncludeActionsBooleanNOBodyWhether the persona's actions take their roles from SelectedRoles. When true, each action's RoleIDCSV is rebuilt from SelectedRoles. Leaving it out, or sending a value that is not true or false, sets it to false.
RunActionsOnSaveBooleanNOBodyWhen true and the persona is enabled, its actions run in the background right after the save. Leaving it out, or sending a value that is not true or false, sets it to false.
IsPrivateBooleanNOBodyMarks the persona as private. A private persona is only visible to people who can manage personas at the site level, or, when it targets a single space, to people who can manage that space's personas. Leaving it out, or sending a value that is not true or false, sets it to false.
PersonaMatchConditionIntegerNOBody0 = Match all conditions, 1 = Match any condition. The value is not checked: any other number is stored as sent. Leaving it out, or sending a value that is not a number, sets it to 0.
ProfileFieldIdIntegerNOBodyThe profile field the condition compares, by the FieldUseID that Get Profile Fields returns. Leaving it out, or sending a value that is not a number, saves the condition with 0.
ConditionOperatorTypeIntegerNOBody0 = Equals, 1 = Does not equal, 2 = Contains, 3 = Does not contain, 4 = Begins with, 5 = Ends with, 6 = Less than or equal to, 7 = Less than, 8 = Equal to, 9 = Greater than, 10 = Greater than or equal to. Leaving it out, or sending a value that is not a number, sets it to 0 (Equals).
ConditionValueStringNOBodyThe value compared against, as a string. For a pick-list field, send the ID of the chosen option (its OptionID in the field's options from Get Profile Fields). Leaving it out empties the value. A JSON list instead of text answers 500 with an empty body, and nothing is saved.
GroupNameStringNOBodyLabel of the condition's group. Leaving it out clears the label. A JSON list instead of text answers 500 with an empty body, and nothing is saved.
ParentIDIntegerNOBody0 for the first condition of a group. A later condition in the same group carries the first condition's ConditionID. A ParentID that is no condition of this persona drops the condition without an error, and a value that is not a number is read as 0. A new condition sent with 0 starts a new group. Every existing group in the body is then moved into it, so those conditions stop being separate groups.
ActionTypeIntegerNOBody1 = Add to space, 2 = Remove from space, 3 = Assign site role. Leaving it out, or sending a value that is not a number, sets it to 0, which is none of the three types. A number outside the list is stored as sent.
ActionValueStringNOBodySpaceID to add the user to or remove the user from, for action types 1 and 2. Every action needs one: leaving it out answers 500 with an empty body, after the persona's own fields and conditions have been saved. For Add to space (1), text that is not a space ID also answers 500, and nothing is saved. A JSON list instead of text answers 500 too.
RoleIDCSVStringNOBodyComma-separated role IDs for the action: for type 1 (Add to space), the space roles the user is given in that space; for type 3 (Assign site role), the site roles assigned. Sent inside each item of PersonaActions. When IncludeActions is true, this value is replaced by SelectedRoles, so send the roles there instead. Leaving it out clears the roles. For Add to space (1), text that is not a list of role IDs answers 500 with an empty body, and nothing is saved. A JSON list instead of text answers 500 too.
SelectedRolesArrayNOBodyList of role IDs for the action, as strings. Used when IncludeActions is true: it replaces RoleIDCSV. Sent inside each item of PersonaActions. Numbers work as well as strings. A value that is not an array, such as a single string, is ignored, and the action is saved with no roles.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
  "Name": "Power User"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "Changes saved successfully",
  "ResponseData": {
    "PersonaID": 8,
    "Name": "Power User",
    "CreatedBy": 42,
    "UpdatedBy": 42,
    "DateCreated": "2026-01-15T13:01:23.43",
    "LastUpdated": "2026-01-15T13:04:10.27",
    "IsEnabled": false,
    "IncludeActions": false,
    "IsPrivate": false,
    "PersonaMatchCondition": 0,
    "PersonaConditions": [],
    "PersonaActions": [],
    "EditAbsoluteURL": "https://your-site.com/personas/addedit/8",
    "DateCreatedString": "01/15/2026",
    "LastUpdatedString": "01/15/2026",
    "RunActionsOnSave": false,
    "CreatedByUserDisplayName": "Jane Doe",
    "UpdatedByUserDisplayName": "Jane Doe",
    "TenantID": 1
  }
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestPersonaID in the path is not an integer.Send a numeric PersonaID and a JSON object body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
200 with IsErrorThe caller can manage neither site-level personas nor the single space the persona's actions target (You do not have sufficient permissions to perform this action.).Call as a site administrator or a manager of that space.
500 Server ErrorThe PersonaID names no persona, the request carries no body, or a text field is a JSON list: the endpoint uses the body without checking it. Other causes: an action without ActionValue, which fails after the persona's own fields and conditions are saved; an Add to space action whose ActionValue or RoleIDCSV is not a number; or a persona that already stores such a RoleIDCSV, which answers 500 to every update. The body is empty.Check the PersonaID, send a JSON body, and send ActionValue and RoleIDCSV as the numbers they name.

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