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 Max: 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 objects 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

curl https://api.emailer.emfluence.com/v1/groups/removeContacts \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
    "groupID": 1,
    "contactIDs": [1,2,3]
	}'

Response Data

{"success":1,"code":0,"data":{"totalSuccess":3,"totalErrors":0,"contactResults":[{"success":1,"errors":[],"contactID":1},{"success":1,"errors":[],"contactID":2},{"success":1,"errors":[],"contactID":3}]},"requestID":"1515884D-E842-4C69-AF1A4F77D7E9D803"}

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

curl https://api.emailer.emfluence.com/v1/groups/removeContacts \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
    "groupID": 2,
    "contactIDs": [4,5,-6,7,7]
	}'

Response Data

{"success":1,"code":0,"warnings":["3 contacts not removed from the group.  See contactResults for details."],"data":{"totalSuccess":2,"totalErrors":3,"contactResults":[{"success":1,"errors":[],"contactID":4},{"success":0,"errors":["Not a member of the group"],"contactID":5},{"success":0,"errors":["Contact record does not exist"],"contactID":-6},{"success":1,"errors":[],"contactID":7},{"success":0,"errors":["Duplicate contactID"],"contactID":7}]},"requestID":"14647904-DD6A-45F2-B0592F583571C5DB"}

API Console

The console uses production data, so BE CAREFUL!

POST

groups/removeContacts

Request Body

{"contactIDs":"","groupID":0}

Access token: *

Groups

POST groups/removeContacts

Parameters

Response Data

Permissions

Example Calls

All contacts removed

Some contacts failed to get removed

API Console