Suppression API Methods

Table of Contents:

 Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used. 

To see API method of creating new Suppression List; please see List API method page.  

Methods Summary

PUT /api/suppression

Description 

This method is used to manage(add/remove contacts) a suppression list.

Request

PUT URL: https://api.ongage.net/<list_id>/api/suppression

list_id

Required integer - Suppression list ID

action

Optional add or remove - Indicate the action you want to do on the suppression list. Default: add

emails

Required array of emails - Note: If you want to suppress all emails for a specific domain, you can use a wildcard *@example.com

{
 "list_id": 1,
 "action": "add",
 "emails": [ "example1@example.com", "example2@example.com", "*@some-domain.com" ]
}

Response

Response includes newly created array of fields.

{
 "metadata":
 {
  "error": false
 },
 "payload":
 {
  "rows": 3,
  "success": 3
 }
}