Skip to main content

Source: https://docs.luxid.lu/en/api/edit-group-memberships/

API version: 1.9

OpenAPI specification: https://docs.luxid.lu/luxid-partner-api.yaml

Add/Remove accounts into/from groups

POST 

/bulk-actions/group-memberships

Add/Remove accounts into/from groups

Request​

Request body​

Content type: application/json

The request body is required.

PropertyTypeRequiredDescription
actionsarray of objectNoList of actions to perform on group memberships. The parter must be manager of the target group(s). List must not contain duplicate (account, group) pair. List is limited to 20 actions max.
actions[].actionstring (ADD, REMOVE)Yes
actions[].accountEmailstringYes
actions[].groupNamestringYes

Responses​

Success

Response schemas​

200 - Success​

Content type: application/json

PropertyTypeRequiredDescription
actionsarray of objectNoList of actions to perform on group memberships
actions[].actionstring (ADD, REMOVE)Yes
actions[].accountEmailstringYes
actions[].groupNamestringYes
actions[].resultstring (ACCOUNT_NOT_FOUND, GROUP_NOT_FOUND, GROUP_FORBIDDEN, ACCOUNT_ADDED_TO_GROUP, ACCOUNT_REMOVED_FROM_GROUP, ACCOUNT_ALREADY_IN_GROUP, ACCOUNT_ALREADY_NOT_IN_GROUP)YesResult of the action

400 - Functional error​

Content type: application/json

PropertyTypeRequiredDescription
messagestringNo
typestringNo