v1

latestOpenAPI 3.0.32026-07-17542197.8 KB

Organization

Role

Update organization role

Update the organization role by its ID.

patch/v1/organizations/${id}/roles/{role_id}

Request body

namestring

Name of the role.

descriptionstring nullable

Description of the role.

Example request

{
  "name": "Contributors",
  "description": "Users who can collaborate on the project."
}

Response

idstring required

Unique identifier of the role.

namestring required

Name of the role.

descriptionstring nullable

Description of the role.

membersstring[] required

IDs of the users assigned to the role.

permissionsstring[] required

IDs of the permissions assigned to the role.

created_atstring date-time required

Date when the organization was created.

updated_atstring date-time nullable required

Date when the organization was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "name": "Collaborators",
  "description": "Users who can collaborate on the project.",
  "members": [
    "9bsv0s46s6s002p9ltq0"
  ],
  "permissions": [
    "9bsv0s46s6s002p9ltq0"
  ]
}