post
https://{host}/v2/userGroup2/transfer
Lets you transfer members from one group to another.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Make sure you have the appropriate access control configured. For more information, see access group documentation.
Example request
curl --location 'https://eu.api.capillarytech.com/v2/userGroup2/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bWFkaHVfcmI3MjU2YQ==' \
--header 'Cookie: _cfuvid=vzCvOnzGrFLOd.qyWq3C1wR4U_d0NN8lePwtil_RTVU-1774957797145-0.0.1.1-604800000' \
--data '{
"leaveGroupId": "3962910",
"joinGroupId": "3963208",
"userIds": [568563144]
}
'Body parameters
| Body parameters | Data type | Mandatory | Description |
|---|---|---|---|
| leaveGroupId | Long | yes | Group ID from which the customer needs to be removed. Ensure the customer is a member of the group. |
| joinGroupId | Long | yes | Group ID to which the customer needs to join. |
| userIds | Array | yes | Unique ID of the customers that you want to transfer to the new group. |
Example response
{
"warnings": [],
"errors": [],
"success": true
}Response parameters
| Parameter | Description |
|---|---|
| warnings | This is an array containing any warning messages generated during the processing of the request. |
| errors | This is an array containing any error messages that were generated if the request failed for some reason. |
| success | This is a boolean value indicating whether the request was successful. |
Error code
| Error code | Description |
|---|---|
| 403 | leaveGroupId and joinGroupId is mandatory. |
| 1619 | group id invalid. |
| 1620 | user id does not belong to group id. |
| 1624 | group transfer not allowed for primary member. |