POST GET contacts/getGroups

Get groups for a single contact. ContactID or email is required.

* required

Parameters

Name	Type	Description
contactID	integer	Unique ID of a contact
email	email-address	An email address of an existing contact

Response Data

Name	Type	Description
groupID	integer	ID of group
groupName	string	Name of group
dateAdded	datetime	Date contact was added to group
suppressed	boolean	Group-level suppression. Suppressed contacts will not receive any emails sent to the group.
dateSuppressed	datetime	Date contact was suppressed in the group

Example Calls

Get groups for a contact by ID

GET

/contacts/getGroups?contactID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/getGroups?contactID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":3,"totalPages":1,"totalRecords":3,"prev":""},"records":[{"dateAdded":"2014-01-16 22:16:00","dateSuppressed":"","suppressed":0,"groupID":111,"groupName":"Retail Customers"},{"dateAdded":"2013-09-14 20:39:00","dateSuppressed":"","suppressed":0,"groupID":333,"groupName":"Frequent Flyers"},{"dateAdded":"2014-01-16 22:16:00","dateSuppressed":"","suppressed":0,"groupID":444,"groupName":"Monthly Newsletter"}]},"code":0,"requestID":"6C599F0A-7925-404D-AACD36623B35307A"}

Get groups for a contact by email

GET

/contacts/getGroups?email=john.doe%40example.com

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/getGroups?email=john.doe%40example.com \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":3,"totalPages":1,"totalRecords":3,"prev":""},"records":[{"dateAdded":"2014-01-16 22:16:00","dateSuppressed":"","suppressed":0,"groupID":111,"groupName":"Retail Customers"},{"dateAdded":"2013-09-14 20:39:00","dateSuppressed":"","suppressed":0,"groupID":333,"groupName":"Frequent Flyers"},{"dateAdded":"2014-01-16 22:16:00","dateSuppressed":"","suppressed":0,"groupID":444,"groupName":"Monthly Newsletter"}]},"code":0,"requestID":"468497F5-56DF-4F31-B96C662200DE9127"}

API Console

The console uses production data, so BE CAREFUL!

GET

contacts/getGroups

Param	Value	Type	Description
contactID		integer	Unique ID of a contact
email		email-address	An email address of an existing contact

Access token: *

Contacts

POST GET contacts/getGroups

Parameters

Response Data

Example Calls

Get groups for a contact by ID

Get groups for a contact by email

API Console