HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

User Group / Replace

put
https://{tenantUrl}/public-api/resources/user-groups/v1.0/

Replace a user group.

Unlike PATCH, the request body is a complete representation: any writable property that is omitted is reset rather than preserved. Use PATCH to change a subset of properties.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
required
integer | null

The partner ID. It must belong to the token's operator.

For sub-operator tokens it is required and non-null on create, and must reference a partner assigned to that sub-operator. On PATCH it may be omitted to retain the existing partner; when supplied it must be non-null and assigned to that sub-operator.

For partner tokens it is always the token's own partner: it defaults to that partner when omitted on create, and any other value, including null, is rejected.

Optional and nullable for global and operator tokens. The partner can be updated only if there are no users added to the user group.

string | null
string | null

Used to store custom information, usually used for external references or metadata to the resource.

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?