FYfynoio
Suppression List

Add User to Suppression List

Changed on

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.

Example request:

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

post/{WSID}/suppressions

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/suppressions
  • 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.

Request body

OR

Example request

{
  "distinct_id": "XXXXXXXX",
  "channel": "email",
  "event_type": [
    "marketing",
    "transactional",
    "otp"
  ],
  "description": "DND",
  "expiry_ts": "2025-08-15T16:25:16.302+05:30"
}

Response

Suppression list updated. _message reflects whether a new suppression record was created ("User has been added to the suppression!", with _id returned) or an existing record for that distinct_id/destination and channel was updated ("User record has been updated!", _id omitted).

statusstring required
_messagestring required

Example response

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

Changes

  • 63b60a94cdbbRevision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

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

  • f620f85db863Revision changes
    • breaking

      added the new required request property

    • breaking

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

    • breaking

      the request's body type changed from no type to object

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property