Suppression Lists API

Suppression List Attributes

id integer	Internal identifier for this suppression list
organization_id integer	The organization this suppression list belongs to
name string	Unique name of this list
global boolean	Whether this suppression list is system global.
mailing_list_id integer	The mailing list this suppression list is for, or `NULL` if it is for the entire organization

id

integer

Internal identifier for this address

suppression_list_id

integer

Identifier of the suppression list for this address

organization_id

integer

Organization id for this address

user_id

integer

The user id that added this address

email

string

Address used by this record. See the “Address Formats” table below for details

address_type

string

Type of this address.

Email address is matched case-insensitively

All addresses at this domain are matched

example: @example.com

The MD5 of the email address is matched

example: 8629e8a722df2930a7513c4955ff886b

GET /ga/api/v2/suppression_lists

Returns an array of suppression lists.

POST /ga/api/v2/suppression_lists

{
  "suppression_list": {
    "name": "New Suppression List",
    "mailing_list_id": null
  }
}

Returns a suppression list object.

PUT /ga/api/v2/suppression_lists/:suppression_list_id

Returns the updated suppression list object.

GET /ga/api/v2/suppression_lists/:suppression_list_id/suppressed_addresses?page=0&per_page=250

This endpoint returns an array of suppressed addresses.

POST /ga/api/v2/suppression_lists/:suppression_list_id/suppressed_addresses/create_multiple

This endpoint accepts a data parameter that contains an array of addresses.

{
  "data": [
    "@example.com",
    "[email protected]",
    "8629e8a722df2930a7513c4955ff886b"
  ]
}

DELETE /ga/api/v2/suppression_lists/:suppression_list_id/suppressed_addresses/:id

The value of :id can either be the internal identifier of the suppressed
address or the address of the record.