Skip to main content
PATCH
/
v1
/
orgs
/
{org_id}
/
roles
/
{role_id}
Update Role
curl --request PATCH \
  --url https://api.letpiper.com/v1/orgs/{org_id}/roles/{role_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ],
  "is_system": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required
​
role_id
string<uuid>
required

Body

application/json

Schema for updating a custom role.

​
name
string | null
Required string length: 1 - 100
​
description
string | null
Maximum string length: 500
​
permissions
string[] | null

Response

Successful Response

Schema for reading role data.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
permissions
string[]
required
​
is_system
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required