Skip to main content
DELETE
Remove embed group members
πŸ”’ Admin only. Requires administrator privileges β€” the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Removes one or more embed users (1–1000 per request) from a group, identified the same way as when adding them β€” exactly one of externalId or embedUserId each. Only this group’s membership is dropped; the users themselves and their other groups are left alone, and unlike adding, an unknown externalId is never provisioned. Idempotent: removing a user who is not a member is a no-op. Returns 204 No Content, or 404 if the group does not exist in this tenant.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

embedTenantName
string
required

Name of the embed tenant (the embedTenantName used to generate embed sessions).

id
integer
required

Numeric id of the group, as returned by the groups endpoints.

Body

application/json

EmbedGroupMembersInput

members
object[]
required

Embed users to add or remove (1–1000 per request).

Required array length: 1 - 1000 elements

Response

Successful response