Sign in
Suppression List

Add User to Suppression List

Add a user to the suppression list for a given channel.

Note: If both distinct_id and destination are provided, distinct_id takes precedence, and destination is ignored.

post/{WSID}/suppressions

Path parameters

WSIDstring required

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

Request body

OR

Example request

{
  "distinct_id": "XXXX-XXX-XXXX",
  "channel": "sms",
  "event_type": [
    "marketing",
    "transactional",
    "otp"
  ],
  "description": "DND"
}

Response

Suppression list updated.

statusstring
_messagestring

Example response

{
  "status": "ok",
  "_message": "User has been added to the suppression!"
}

Changes

Changed in 2 of the 35 revisions of this API.12

  • ee288e1ee67d11See the full diff
    • ▲

      removed subschema #1 subschema #2 from the request body oneOf list

      request-body-one-of-removed

    • ○

      added subschema #1 subschema #2 to the request body oneOf list

      request-body-one-of-added

  • 78516a59bb231See the full diff
    • ○

      endpoint added

      endpoint-added