v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
People

Update a persona's role

Updates the role of the specified persona.

patch/personas/{personaId}/role

Path parameters

personaIdstring uuid required

The ID of the persona to work with.

Example:8e214819-5c83-429f-a976-eb127a0a8a88

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

roleName'Owner' | 'Admin' | 'Payer' | 'Viewer' | 'Accountant' | 'User' required

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

Example request

{
  "roleName": "Accountant"
}

Response

OK

name'Owner' | 'Admin' | 'Payer' | 'Viewer' | 'Accountant' | 'User' required

The persona's newly-assigned role.

Example response

{
  "name": "Accountant"
}