GreenArrow Documentation

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

Suppressed Address Attributes

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.

a

Email address is matched case-insensitively

example: [email protected]

d

All addresses at this domain are matched

example: @example.com

m

The MD5 of the lowercased email address is matched

example: 8629e8a722df2930a7513c4955ff886b

s

The SHA256 of the lowercased email address is matched.

example: 973dfe463ec85785f5f95af5ba3906eedb2d931c24e69824a89ea65dba4e813b

Address Formats

Get a list of suppression lists

URL

GET /ga/api/v2/suppression_lists

Response

Returns an array of suppression lists.

Create a new suppression list

URL

POST /ga/api/v2/suppression_lists

Post Data

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

Response

Returns a suppression list object.

Update an existing suppression list

URL

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

Response

Returns the updated suppression list object.

Get a list of suppressed addresses

URL

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

Response

This endpoint returns an array of suppressed addresses.

Add new suppressed addresses

URL

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

Post Data

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

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

Remove an address from the suppression list

URL

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.