Returns status code

200

Request url

/suppressions?query[name]=mySuppression&fields=name,createdOn&sort[createdOn]=desc&page=4&perPage=30

Request params

Field nameField typeField description
queryhashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
name*
createdOn[from]Y-m-d
createdOn[to]Y-m-d
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
nameasc,desc
createdOnasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "suppressionId": "FFF",
        "name": "name54d86d0a5beba",
        "createdOn": "2015-02-09T08:17:16+0000",
        "href": "https://api.getresponse.com/v3/suppressions/FFF"
    },
    {
        "suppressionId": "FX4",
        "name": "name54d871218387d",
        "createdOn": "2015-02-09T08:34:45+0000",
        "href": "https://api.getresponse.com/v3/suppressions/FX4"
    }
]

Returns status code

201

Example Response

{
    "suppressionId": "bG9",
    "name": "nameSuppr548fj",
    "createdOn": "2015-09-14T10:41:03+0000",
    "href": "https://api.getresponse.com/v3/suppressions/bG9",
    "masks": [
        "@interia.pl",
        "@onet.pl"
    ]
}

Possible Errors


Returns status code

204

Returns status code

200

Example Response

{
    "suppressionId": "FFF",
    "name": "name54d86d0a5beba",
    "createdOn": "2015-02-09T08:17:16+0000",
    "href": "https://api.getresponse.com/v3/suppressions/FFF",
    "masks": [
        "@onet.pl",
        "@wp.pl"
    ]
}

Returns status code

201

Example Response

{
    "suppressionId": "FFF",
    "name": "name54d86d0a5beba",
    "createdOn": "2015-02-09T08:17:16+0000",
    "href": "https://api.getresponse.com/v3/suppressions/FFF",
    "masks": [
        "@giergielewicz.pl",
        "@onet.pl",
        "@wp.pl"
    ]
}