Resets any project recipients with scores below the default and/or any suppression state applied.

Request Fields

These are passed in as arguments at the top level of the request.

Key Type Description
addresses array Array of recipient email addresses.

Request Example

{
  "api_key" : "__ACCOUNT_API__KEY__",
  "arguments": {
    "addresses": [ "test@example.com", "test@example.net", "test@example.org" ]
  }
}

Response 200 Ok

If the request was successful, a standard response looks like the following:

{
  "response": {
    "status": "ok",
    "message": "3 recipient scores reset to default, any suppression states removed"
  },
  "data": {
    "count": 0
  }
}

Response 412 Precondition Failed

Use of this endpoint requires permission to recipient suppression state. If the account is lacking this permission a 412 response will be generated.

{
  "response":
  {
    "status": "precondition_failed",
    "message":  "Account is not permitted to alter suppression status of recipients"
  }
}