Embedded APIResourcesCustomer workspace collaborators

Remove members from a customer workspace collaborator group

Removes one or more members from a collaborator group in an Embedded workspace by their workspace user IDs.

EARLY ACCESS FEATURE
This access control endpoint is in limited preview. The access control model is under active development and may change. Contact your Customer Success Manager to participate in early access testing.
CONDITIONAL REQUIREMENTS
Requests must include either user_ids or member_invitation_ids to specify which collaborators to remove from the group. You may include both to remove collaborators based on multiple criteria.

Path parameters

managed_user_idstringRequired

The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an E, for example: EA2300.

idstringRequired
The ID of the collaborator group to delete members from.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

user_idsintegerRequired

This parameter is conditionally required. The workspace user IDs to remove from the collaborator group. Use repeated query parameters, for example: user_ids=1&user_ids=2.

member_invitation_idsintegerRequired
This parameter is conditionally required. A list of IDs for collaborator group invitations. Members who were added by the invitations are removed from the group.

Errors