POST groups/addContacts

Add one or more existing contacts to a group.

* required

Parameters

Name	Type	Description
groupID *	integer	Unique ID of a group. Contacts cannot be added to dynamic groups.
contactIDs *	array[integer]	Unique ID of a contact Max: 1000

Response Data

If a contact fails to get added to the group for any reason, details will be provided in the errors array within contactResults for that particular row.

Name	Type	Description
totalErrors	int	Number of contacts not added to the group (check contactResults for specific errors)
totalSuccess	int	Number of contacts added to the group
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 added

POST

/groups/addContacts

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/addContacts \
	-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":"431C299F-AE60-45A6-B693C5FBCCDF64CA"}

Some contacts failed to get added

Individual rows in the contactIDs array can fail independently from the API call itself. If a contact fails to get added to 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/addContacts

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/addContacts \
	-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 added to the group.  See contactResults for details."],"data":{"totalSuccess":2,"totalErrors":3,"contactResults":[{"success":1,"errors":[],"contactID":4},{"success":0,"errors":["Already in 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":"FEC01A29-1E4F-4713-9581CB96960C6F60"}

API Console

The console uses production data, so BE CAREFUL!

POST

groups/addContacts

Request Body

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

Access token: *

Groups

POST groups/addContacts

Parameters

Response Data

Permissions

Example Calls

All contacts added

Some contacts failed to get added

API Console