Update a persona's role

Updates the role of the specified persona.

SecurityCommonAuth
Request
path Parameters
personaId
required
string <uuid> (personaId) <= 36 characters

The ID of the persona to work with.

Example: 8e214819-5c83-429f-a976-eb127a0a8a88
query Parameters
accountId
required
string (accountId)

The ID of the account you want to use.

Example: accountId=F50091
Request Body schema: application/json
roleName
required
string

The name of the new role that you want to assign to the persona.

Enum: "Owner" "Admin" "Payer" "Viewer" "Accountant" "User"
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

patch/personas/{personaId}/role
Request samples
application/json
{
  • "roleName": "Accountant"
}
Response samples
application/json
{
  • "name": "Accountant"
}