v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

Update an org group

Update the name of an existing organization group.

patch/api/v2/org_groups/{org_group_id}

Path parameters

org_group_idstring uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef0123456789

The ID of the org group.

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "Updated Org Group Name"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
    "type": "org_groups"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "created_at": "2024-01-15T10:30:00Z",
      "modified_at": "2024-01-15T10:30:00Z",
      "name": "My Org Group",
      "owner_org_site": "us1",
      "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
    "type": "org_groups"
  }
}