REST API

⌘K
  2. Home
  4. Docs
  6. REST API
  8. API Reference
  10. Groups and Suppression Lists

Groups and Suppression Lists

Groups and suppression lists are simply collections of email addresses. They may be used to filter mailing campaigns, or (in the FeedBlitz UI) as the basis for other bulk operations.

Suppression Lists

Suppression lists predate groups at FeedBlitz, and can only be used to exclude email addresses from a bulk mailing. Since groups can now be used to include and exclude addresses from mailing campaigns, as well as being automated via triggers, groups are more powerful and more flexible than suppression lists. There is therefor no need to use suppression lists any more and you should consider them deprecated, unless the account already has one or more suppression lists defined. In which case, you can access suppression lists via API in exactly the same way as you do groups, except that in the resource paths and XML you replace the string “group” with “suppressionlist”

Resource path: /groups/<groupid>

GET Method

Returns group metadata and the emails in it for the specified group id, or if one isn’t specified, metadata about all groups in the account.

Returned XML for all groups is of the following form:

<?xml version="1.0" encoding="UTF-8"?>
<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<rsp stat="ok">
<success code="0" msg="Authorized" />
</rsp>
<groups>
<group>
<id>1145</id>
<title>Test from 10/29</title>
<description>Testing, testing, 123</description>
<created>2018-10-29 18:35:41</created>
<lastupdated>2018-10-29 19:36:24</lastupdated>
<count>86</count>
<status>ok</status>
</group>
<group>
<id>2</id>
<title>First group</title>
<description>Tracking store sales</description>
<created>2016-05-04 13:10:23</created>
<lastupdated>2017-12-06 19:38:34</lastupdated>
<count>81815</count>
<status>ok</status>
</group>
</groups>
</feedblitzapi>

When a valid group ID is specified, the returned XML is like this:

<?xml version="1.0" encoding="UTF-8"?>
<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<rsp stat="ok">
<success code="0" msg="Authorized" />
</rsp>
<groups>
<group>
<id>1145</id>
<status>ok</status>
<emails>
... a comma separated list of email addresses ...
</emails>
</group>
</groups>
</feedblitzapi>

DELETE Method

Moves the specified group id into the deleted state. You must specify a valid group ID in the resource path for this method to succeed.

POST method

Modify the group, including adding emails. New emails are added, email addresses already in the group are deduplicated. You must provide a valid group ID in the resource path and the supplied XML. You only need provide the elements you wish to change.

Example POST XML:

<?xml version="1.0" encoding="utf-8"?>
<feedblitzapi xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0">
<groups>
<group>
<id>29</id>
<title>New title via the API</title>
<description>Description via the API</description>
<emails>foo@bar.com</emails>
</group>
</groups>
</feedblitzapi>

PUT method

Creates a new group by sending XML data to the /groups resource.

XML is identical to the POST example above, except that no <id> field is allowed. You can parse the returned XML if the call is successful for the ID of the new group.