Patch group

Updates an existing group resource, i.e. a Miro user group, overwriting values for the specified attributes. Patch operation for group can be used to add, remove, or replace user group members and to update the display name of the group (user group).

To add a user to the group (user group), use the add operation.
To remove a user from a group (user group), use the remove operation.
To update the display name, use the replace operation. The maximum length of the displayName is 60 characters; longer values are truncated.

Note: Attributes that are not provided will remain unchanged. The patch operation only updates the fields provided.

User group members removal specifics:
For remove or replace operations, the user is removed from the user group only. This does not remove the user from any team or from the organization, does not transfer board ownership, and does not change the user license. There is no last-admin restriction for user groups. Removing a user who is not a member of the user group is a no-op.

Add user group members specifics:
All added members are reactivated or recreated if they were deactivated or deleted earlier, and their license is upgraded to FULL. On organizations with verified SAML domains, the email of the added user is confirmed. Adding a user that is already a member of the user group is a no-op.

External users specifics:
When adding existing users with the role ORGANIZATION_EXTERNAL_USER or ORGANIZATION_TEAM_GUEST_USER to a user group, we set FULL license and ORGANIZATION_INTERNAL_USER roles.

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

Group (user group) ID. A server-assigned, unique identifier for this Group (user group).

Query Params
string

A comma-separated list of attribute names to return in the response.

Example attributes: id,displayName
It is also possible to fetch attributes within complex attributes, for Example: members.display

Body Params

Payload to add, replace, remove members in the specified group (user group).

The body of a PATCH request must contain the attribute Operations and its value is an array of one or more PATCH operations. Each PATCH operation object must have exactly one op member.

schemas
array of strings
enum
required

Identifies which schema(s) this resource uses. In this case it is the PatchOp schema.

schemas*
Operations
array of objects
required

A list of patch operations.

Multiple users can be added or removed from the group (user group) in one request. Use the array to add or remove multiple users.

For updating the user group name:
"op"="replace", "path"="displayName", "value"="New group name" must be provided in the Operations array.

Operations*
Headers
string
enum
Defaults to application/scim+json

Generated from available response content types

Allowed:
string
enum
Defaults to application/scim+json

Generated from available request content types

Allowed:
Responses

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