Update a persona's role

Updates the role of the specified persona.

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

The ID of the persona to work with.

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

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

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

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

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