Update user group

Updates a user group in an organization.
For user groups that are managed externally (for example, provisioned through SCIM), the description property cannot be changed, and the name property cannot be changed while externalNameSynced is true. For user groups that are not managed externally, the externalNameSynced property cannot be set. Requests that violate these rules return a 400 error.

Required scope

organizations:groups:write

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

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

The ID of an organization.

string
required

The ID of a user group.

Body Params
string
length between 1 and 60

New name for the user group being updated. For user groups that are managed externally, the name can be changed only when externalNameSynced is false.

string
length between 0 and 300

New description of the user group. The description cannot be changed for user groups that are managed externally.

boolean

Set to true to keep the Miro name of the user group synchronized with its external (IdP) name, or false to manage the name in Miro independently. Can be set only for externally-managed user groups.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json