Update an organization user group

Updates the specified organization user group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/organizations/{organizationId}/user-groups/{id}
JWTorganization:userGroup:update

Path parameters

organizationIdstringrequired
idstringrequired

Unique identifier for the organization user group.

Request body

namestring

Name of the user group. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

descriptionstring

Description for the user group. Any printable characters and line breaks. Cannot contain control characters other than tab, carriage return and line feed, nor invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [0,256]Pattern: ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
descriptionstringrequired