User groups (Beta)

Update user group

Update a user group by ID.

Note:

  • This endpoint is now in Beta, disabled for general availability at this time.
  • Please note that this endpoint is available only for API keys with Admin permissions.
put/management/user_groups/{groupId}

Request

Path parameters

groupIdstring required

The ID of the user group

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

groupNamestring
memberIdsstring[]

Response

User group updated and the changes are pending approval

namestring
idstring
memberIdsstring[]
statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.