Skip to main content
PUT
/
admin
/
roles
/
{role_id}
Update Role
curl --request PUT \
  --url https://api.decodahealth.com/admin/roles/{role_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "userType": "ADMIN"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "userType": "ADMIN",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
role_id
string
required

Body

application/json
​
name
string | null

Updated role name

​
description
string | null

Updated role description

​
userType
enum<string> | null

Updated role type

Available options:
ADMIN,
PROVIDER,
USER

Response

Successful Response

Extended role information including permissions

​
id
string
required

Unique identifier for the role

​
name
string
required

Role name (e.g., 'admin', 'user', 'billing_manager')

​
userType
enum<string>
required

Role type (ADMIN, PROVIDER, USER)

Available options:
ADMIN,
PROVIDER,
USER
​
createdDate
string<date-time> | null

When the role was created

​
updatedDate
string<date-time> | null

When the role was last updated

​
description
string | null

Description of what this role does

​
permissions
string[]

List of permission strings