Suppression List

Bulk add users to the suppression list. Use this endpoint to suppress multiple destinations (e.g. email addresses or phone numbers) on a given channel in a single request, instead of calling Add User to Suppression List once per user.

Each item in the batch array is one user to suppress. The batch is processed asynchronously, and a 202 response means it has been accepted for processing.

Example request:

POST {{API_URL}}/v1/{{WSID}}/suppressions/ingest

post/{WSID}/suppressions/ingest

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/suppressions/ingest
  • Auth
    HTTP bearer

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

Headers

version'live' | 'test' required

API version identifier.

Request body

Example request

{
  "batch": [
    {
      "destination": "abcde@fghi.com",
      "channel": "email"
    }
  ]
}

Response

The batch of users has been accepted and will be added to the suppression list asynchronously.

statusstring required

Example response

{
  "status": "success"
}

Changes