POST groups/save

Add/update a single group record. Dynamic groups cannot be created through the API.

* required

Parameters

Name	Type	Description
groupID	integer	Unique ID of a group
groupName	string	Name of group. Must be unique
status	string	One of: Active, Archived. Archived groups are hidden by default. Allowed Values: Active, Archived
protected	boolean	Protected groups cannot be archived or deleted. Groups that are populated from external sources should be marked as protected. Default: 0
description	string	Description of group. Displayed to contacts on preferences page.
friendlyName	string	Name displayed to contacts on preferences page. Defaults to groupName
private	boolean	Do not display this group on contact preferences page Default: 1
userIDs	array[integer]	Users who have access to this group
notes	string	Extra information about group. For internal use only.
externalID	string	ID of record in client system

Response Data

Returns a fully populated group object

Name	Type	Description
activeMembers	integer	Number of active (not held/suppressed) contacts in group
autoResponseEmailID	integer	ID of email contacts will receive when added to group
dateAdded	datetime	Date record was added
dateLastEmailSent	datetime	Date group was last sent an email
dateModified	datetime	Date record was modified
description	string	Description of group. Displayed to contacts on preferences page.
externalID	string	ID of record in client system
friendlyName	string	Name displayed to contacts on preferences page. Defaults to groupName
groupID	integer	Unique ID of a group
groupName	string	Name of group. Must be unique
notes	string	Extra information about group. For internal use only.
private	boolean	Do not display this group on contact preferences page
protected	boolean	Protected groups cannot be archived or deleted. Groups that are populated from external sources should be marked as protected.
sendTests	boolean	Group can be used for sending test emails
status	string	One of: Active, Archived. Archived groups are hidden by default.
totalMembers	integer	Total number of contacts in group
type	string	One of: Static, Dynamic. Dynamic groups cannot have contacts added to them because their members are determined by a query.
userID	integer	ID of system user group belongs to
userIDs	array[integer]	Users who have access to this group

Permissions

Method requires the Create Groups permission

Example Calls

Create new group

New groups must have a unique groupName. Other parameters are optional.

POST

/groups/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"groupName": "My Unique Group"
	}'

Response Data

{"success":1,"data":{"status":"Active","groupName":"My Unique Group","friendlyName":"","sendTests":0,"totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2014-03-31 16:40:43","description":"","groupID":123,"userIDs":[],"private":1,"notes":"","protected":0,"type":"Static","dateModified":"2014-03-31 16:40:43","autoResponseEmailID":"","userID":123},"code":0,"requestID":"D86F208E-1024-44AD-A7EF4D7EFEB61634"}

Update single group property

Updates can pass in just the changes

POST

/groups/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"groupID": 123,
		"groupName": "My Unique Group 2"
	}'

Response Data

{"success":1,"data":{"status":"Active","groupName":"My Unique Group 2","friendlyName":"","sendTests":0,"totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2014-03-31 16:40:43","description":"","groupID":123,"userIDs":[],"private":1,"notes":"","protected":0,"type":"Static","dateModified":"2014-03-31 16:43:23","autoResponseEmailID":"","userID":123},"code":0,"requestID":"50DFAFE7-92B4-419A-A47B98CC80E87AEE"}

Update group using object

Updates can pass in a fully populated group object. A group object can be obtained by calling groups/lookup. They are also returned after a save operation.

POST

/groups/save

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/save \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
        "friendlyName": "Weekly Updates",
        "sendTests": 0,
        "totalMembers": 1000,
        "activeMembers": 500,
		"dateLastEmailSent": "2015-02-12 00:42:00",
        "dateAdded": "2014-03-31 16:40:43",
        "description": "",
        "groupID": 123,
        "userIDs": [],
        "private": 1,
        "groupName": "My Unique Group 2",
        "dateModified": "2014-03-31 16:43:23",
        "autoResponseEmailID": "",
        "userID": 123
    }'

Response Data

{"success":1,"data":{"groupName":"My Unique Group 2","status":"Active","friendlyName":"Weekly Updates","sendTests":0,"totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2014-03-31 16:40:43","description":"","groupID":123,"userIDs":[],"private":1,"notes":"","protected":0,"type":"Static","dateModified":"2014-03-31 16:43:23","autoResponseEmailID":"","userID":123},"code":0,"requestID":"F31B71A7-7506-478A-A3F353701CAB0BC6"}

API Console

The console uses production data, so BE CAREFUL!

POST

groups/save

Request Body

{"friendlyName":"","externalID":"","private":"1","notes":"","status":"","userIDs":"","groupID":0,"protected":"0","groupName":"","description":""}

Access token: *