Sample - OpenAI API
POST/projects/{project_id}/roles/{role_id}

Update a project role

Updates an existing project role. Provide any role properties you want to change through permissions, description, or role_name; fields that are not supplied are not described as changed by this operation.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 3 body fields
project_idstringrequired
The ID of the project to update.
role_idstringrequired
The ID of the role to update.

Fields to update on the project role.

permissionsarray<string>optional
Updated set of permissions for the role.
descriptionstringoptional
New description for the role.
role_namestringoptional
New name for the role.

2 status codes
200Returns the updated project role with its identifier, name, description, permissions, resource type, and predefined-role status.
objectstringrequired
Always `role`.
Allowed:role
idstringrequired
Identifier for the role.
namestringrequired
Unique name for the role.
descriptionstringrequired
Optional description of the role.
permissionsarray<string>required
Permissions granted by the role.
resource_typestringrequired
Resource type the role is bound to (for example `api.organization` or `api.project`).
predefined_rolebooleanrequired
Whether the role is predefined and managed by OpenAI.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds the applicable rate limit. permissions, description, and role_name may each be a value or null, so send values that represent the intended updated role configuration.