POST contacts/saveGroups

Save groups for an existing contact. ContactID or email is required. By default, this call mirrors the functionality of /contacts/save when passing the "groupIDs" parameter. However, here you can include a "suppressed" flag per group which allows you to set group-level suppression.

* required

Parameters

Name	Type	Description
contactID	integer	Unique ID of a contact
email	email-address	An email address of an existing contact
groups *	array	Array of objects holding group subscription data. Each object must contain the key "groupID" and may contain an optional "suppressed" key. [{"groupID":123}] or [{"groupID":123,"suppressed":1}]. If "suppressed" key is not passed, it will default to 0. Contacts cannot be added to dynamic groups.

Response Data

Method returns no data

Permissions

Method requires the Contacts (Edit) permission

Example Calls

Add contact to groups

This example suppresses the contact in one group and unsuppresses them in another.

POST

/contacts/saveGroups

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/saveGroups \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"contactID": 123,			
		"groups": [{"groupID":123,"suppressed":1},"groupID":456,"suppressed":0}]
	}'

Response Data

{"success":1,"data":{},"code":0,"requestID":"E921CD9E-8501-4376-A8E4B51BE3218D98"}

API Console

The console uses production data, so BE CAREFUL!

POST

contacts/saveGroups

Request Body

{"groups":[],"contactID":0,"email":""}

Access token: *