Groups (Preferred)

Remove users from a group

Removes one or more users from the specified group. Pass a single-element array to remove one user.

Users not currently in the group are silently ignored (the operation is idempotent). An empty user_ids array is accepted and is a no-op.

Requires the GROUPMANAGEMENT security role.

post/api/1/groups/{groupId}/remove-users

Request

  • Base URL
    https://{your-bynder-domain}
  • URL
    https://{your-bynder-domain}/api/1/groups/{groupId}/remove-users
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://{your-auth-url}
      Client credentials
      Token URL: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: GROUPMANAGEMENT

Path parameters

groupIdstring uuid required

ID of the group (hyphens optional).

Request body

user_idsstring[] required

IDs of the users to add or remove. An empty list is a no-op.

Response

Users removed successfully.

user_countinteger

Updated number of members in the group after the operation.

Changes

No recorded changes to this operation across all 1 revision of this API.