POST groups/removeContacts

Remove one or more existing contacts from a group.

* required

Parameters

Name Type Description
groupID * integer Unique ID of a group
contactIDs * array[integer] Unique ID of a contact
1000

Response Data

If a contact fails to get removed from the group for any reason, details will be provided in the errors array within contactResults for that particular row.
Name Type Description
totalSuccess int Number of contacts removed from the group
totalErrors int Number of contacts not removed from the group (check contactResults for specific errors)
contactResults array Array of structs containing results for each row from the contactIDs argument (the order will be the same). Each row will contain: contactID, success, and errors. e.g "contactsResults":[{"contactID": 123, "success": 1, "errors": []}]

Permissions

Method requires the Contacts (Edit) permission

Example Calls

All contacts removed

POST
/groups/removeContacts
cURL
Copy
Response Data

Some contacts failed to get removed

Individual rows in the contactIDs array can fail independently from the API call itself. If a contact fails to get removed from the group, it will still be included in the "contactResults" array but success will be 0 and the errors array will contain details about the error.

POST
/groups/removeContacts
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
POST
groups/removeContacts
Request Body
{"groupID":0,"contactIDs":""}
Access token: *