Patch group

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

To add a user to the group (team), use add operation.
To remove a user from a group (team), use remove operation.
To update a user resource, use the replace operation.
The last team admin cannot be removed from the team.

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

Team members removal specifics:
For remove or replace operations, the team member is removed from the team and from all team boards. The ownership of boards that belong to the removed team member is transferred to the oldest team member who currently has an admin role. After you remove a team member, adding the team member again to the team does not automatically restore their previous ownership of the boards. If the user is not registered fully in Miro and is not assigned to any other team, the user is also removed from the organization.

Add team members specifics:
All added team members are reactivated or recreated if they were deactivated or deleted earlier.

External users specifics:
When adding existing users with the role ORGANIZATION_EXTERNAL_USER or ORGANIZATION_TEAM_GUEST_USER to a team, 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 (Team) ID. A server-assigned, unique identifier for this Group (team).

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 (team).

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 (team) in one request. use the array to add or remove multiple users.

For updating security group name:
"op"="replace", "value"={"id":"13266533725732", "displayName":"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