PUT
/
accounts
/
{id}
/
role
curl -X PUT \
 /accounts/{id}/role \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '[]'
{
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "user": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "firstName": "John",
    "lastName": "Doe",
    "email": "jsmith@example.com"
  },
  "role": "administrator",
  "createdAt": "2023-11-07T05:31:56Z",
  "deactivated": true
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Account identifier

Body

The updated Account resource
​
role
enum<string>
required

The role to set for the account.

Available options:
read-only,
administrator,
account

Response

200
application/json
Account resource updated
​
id
string
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

​
user
object
​
role
enum<string>
default:administrator
Available options:
administrator,
account,
read-only
Example:

"administrator"

​
createdAt
string
​
deactivated
boolean

Was this page helpful?

Suggest editsRaise issue