API Reference

Admin

Organization

Groups

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update group

GroupUpdateResponse admin().organization().groups().update(GroupUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/organization/groups/{group_id}

Updates a group’s information.

ParametersExpand Collapse

GroupUpdateParams params

Optional<String> groupId

String name

New display name for the group.

minLength1

maxLength255

ReturnsExpand Collapse

class GroupUpdateResponse:

Response returned after updating a group.

String id

Identifier for the group.

long createdAt

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

formatunixtime

boolean isScimManaged

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

String name

Updated display name for the group.

Update group

Java

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.groups.GroupUpdateParams;
import com.openai.models.admin.organization.groups.GroupUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        GroupUpdateParams params = GroupUpdateParams.builder()
            .groupId("group_id")
            .name("x")
            .build();
        GroupUpdateResponse group = client.admin().organization().groups().update(params);
    }
}

{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Escalations",
    "created_at": 1711471533,
    "is_scim_managed": false
}

Returns Examples

{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Escalations",
    "created_at": 1711471533,
    "is_scim_managed": false
}