Remove
Remove Single User
Remove a single user from one or more existing groups.
Parameters
Key
Type
groups
Array of Strings
String (Valid Email)
Example
curl -X POST \
v1/groups/remove \
-H 'Authorization: Basic <Your Base64 Encoded Token>' \
-d '{
"groups" : ["Group One","Group Two","Group Three"],
"email" : "test@example.com"
}'
Success Response
{
"status": "success",
"data": [
{
"group": "Group One",
"status": "success",
"deletes": 1,
"warnings": 0
},
{
"group": "Group Two",
"status": "success",
"deletes": 1,
"warnings": 0
},
{
"group": "Group Three",
"status": "error",
"message": "Group Not Found"
}
],
"hash": "15f408f262307f3777478b808fd2696e",
"response_time": 0.11130118370056152
}
Remove All Groups
Remove multiple users from all groups
Parameters
Key
Type
Array<String>
Example
curl -X POST \
v1/groups/remove-all \
-H 'Authorization: Basic <Your Base64 Encoded Token>' \
-d '{
"emails" : ["test@example.com","test2@example.com"]
}'
Success Response
{
"status": "success",
"data": [
{
"name": "Group A",
"deletes": 1
},
{
"name": "Group B",
"deletes": 2
},
...etc
],
"hash": "82191e011754fb04587e9b34764c445c",
"response_time": 0.1109821319580078
}
Last updated