Skip to content
API Reference
Organization
Groups

Update group

POST/organization/groups/{group_id}

Updates a group's information.

Path ParametersExpand Collapse
group_id: string
Body ParametersJSONExpand Collapse
name: string

New display name for the group.

minLength1
maxLength255
ReturnsExpand Collapse
id: string

Identifier for the group.

created_at: number

Unix timestamp (in seconds) when the group was created.

formatint64
is_scim_managed: boolean

Whether the group is managed through SCIM and controlled by your identity provider.

name: string

Updated display name for the group.

Update group

curl https://api.openai.com/v1/organization/groups/$GROUP_ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "name": "x"
        }'
{
  "id": "id",
  "created_at": 0,
  "is_scim_managed": true,
  "name": "name"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "is_scim_managed": true,
  "name": "name"
}