Transfer Group Member

Lets you transfer members from one group to another.


Pass at lease one among the query parameters. - id, externalId, primaryUserId.


Make sure you have the appropriate access control configured. For more information, see access group documentation.

API endpoint


Body parameters

Body parametersDescription
leaveGroupIdGroup ID from which the customer needs to be removed. Ensure the customer is a member of the group.
joinGroupIdGroup ID to which the customer needs to join.
userIdsUnique ID of the customers that you want to transfer to the new group.

Response parameters

warningsThis is an array containing any warning messages generated during the processing of the request.
errorsThis is an array containing any error messages that were generated if the request failed for some reason.
successThis is a boolean value indicating whether the request was successful.
Click Try It! to start a request and see the response here!