Add User to Suppression List | Fyno Documentation

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

Authentication

AuthorizationBearer

Enter your API Key. If you don't have it already, you can create one from the API Keys page within your Fyno account

Path parameters

WSIDstringRequired

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

Request

This endpoint expects an object.

objectRequired

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).

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

_messagestring

Errors

400

Bad Request Error

401

Unauthorized Error