Loading ...

REST API: Add Persona | Axero Documentation

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

REST API: Add Persona

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

Used to create a new persona

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 Persona created

Optional Parameters

ParameterTypeRequiredLocationDescription
IsEnabledBooleanNOBodyIf Persona created is to be active or not. True or False. Default is False
IncludeActionsBooleanNOBodyIndicates if actions are included when conditions are met. True or False.
RunActionOnSaveBooleanNOBodyIndicates if actions made will run when persona is created. True or False.
PersonaMatchConditionIntegerNOBody0 = Match all conditions 1 = Match any conditions
ProfileFieldIdIntegerNOBodyField to compare condition with. See How to get a ProfileFieldId documentation.
ConditionOperatorTypeIntegerNOBodyEquals = 0,Doesn't Equal = 1,Contains = 2,Doesn't Contain = 3,Begins With = 4,Ends With = 5,Less Than Or Equal To = 6,Less Than = 7,Equal To = 8,Greater Than = 9,Greater Than Or Equal To = 10
ConditionValueIntegerNOBodyIf condition is text, then a string value is here. If condition is from a picklist: Use REST API: GET Profile Fields to get valid fields. Search for the picklist in result response. Find the desired choice in that picklist. Insert the OptionID here of that choice.
ActionTypeIntegerNOBody1 = Add to space 2 = Remove from space
ActionValueStringNOBodySpaceID to be added to or removed from

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
"Name": "Human Resources",
    "IsEnabled": true,
    "IncludeActions": true,
    "PersonaMatchCondition": 0,
    "RunActionsOnSave": false,
    "PersonaConditions":
        [{
          "ProfileFieldID": 67,
          "ConditionValue": 611,
          "ConditionOperatorType": 0
        }],
    "PersonaActions":
        [{
          "ActionValue": "291",
          "ActionType": 1
        }]
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "Changes saved successfully",
  "ResponseData": {
    "PersonaID": 8,
    "Name": "Human Resources",
    "CreatedBy": 376,
    "UpdatedBy": 376,
    "LastUpdated": "2026-01-01T12:00:00Z",
    "IsEnabled": true,
    "IncludeActions": true,
    "PersonaMatchCondition": 0,
    "PersonaConditions": [
      {
        "ConditionID": 10,
        "PersonaID": 8,
        "ProfileFieldID": 67,
        "ConditionValue": "611",
        "CreatedBy": 376,
        "UpdatedBy": 376,
        "LastUpdated": "2026-01-01T12:00:00Z",
        "ConditionOperatorType": 0
      }
    ],
    "PersonaActions": [
      {
        "ActionID": 4,
        "PersonaID": 8,
        "ActionValue": "291",
        "CreatedBy": 376,
        "UpdatedBy": 376,
        "LastUpdated": "2026-01-01T12:00:00Z",
        "ActionType": 1
      }
    ],
    "LastUpdatedString": "2026-01-01T12:00:00Z",
    "RunActionsOnSave": false
  }
}

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. (persona)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