Sample - OpenAI API
POST/organization/groups/{group_id}

Update a group

Updates an existing group's display name. Supply name with the new name for the group, using a value between 1 and 255 characters. A successful response returns the group's identifier, updated name, creation timestamp, and SCIM management status.

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

1 parameter · 1 body field
group_idstringrequired
The unique identifier of the group to update.

Attributes to set on the existing group.

namestringrequired
New display name for the group.

2 status codes
200Returns the updated group object with its identifier, display name, creation timestamp, and whether it is managed through SCIM.
idstringrequired
Identifier for the group.
namestringrequired
Updated display name for the group.
created_atintegerrequired
Unix timestamp (in seconds) when the group was created.
is_scim_managedbooleanrequired
Whether the group is managed through SCIM and controlled by your identity provider.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

name is required and must contain between 1 and 255 characters. group_id must identify the group you want to update. A 429 is returned when the request exceeds the applicable rate limit.