OrgsSitegroups

updateOrgSiteGroup

PUT
/api/v1/orgs/{org_id}/sitegroups/{sitegroup_id}

Update the display name used to identify a site group in the organization.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
sitegroup_id*string
Formatuuid

Request Body

application/json

Request Body

Request body containing a name value

name?string

Value to create or update as the target resource name

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sitegroups/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "site_ids": [    "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"  ]}