FYfynoio
Suppression List

Delete User from Suppression List

Changed on

Delete a suppression entry using its _id, or a combination of distinct_id or destination and channel.

How the parameters are resolved:

  • If _id is provided, it takes precedence over all other parameters.
  • Otherwise, provide either distinct_id or destination. If you provide both, distinct_id takes precedence and destination is ignored.
  • Add channel to remove the suppression on that channel only, for example to unblock sms while keeping whatsapp suppressed for the same number.
  • If channel is omitted, the suppression is removed across all channels for that distinct_id or destination.
delete/{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.

Query parameters

_idstring

Unique identifier of the suppression record to delete, for example 68763be4b8cee01156d9fa8a. You can get this value from the Get Users endpoint.

distinct_idstring

The distinct ID you use to identify the user, for example XXXXXXXX. Use this as an alternative to destination.

destinationstring

The suppressed email address, phone number, or push token, for example abcde@fghi.com, +49XXXXXXXXX, or ExponentPushToken[XXXXX]. Enter a phone number with the country code.

channelstring

The channel to remove the suppression for, for example sms, email, whatsapp, or push. Use this along with distinct_id or destination to unblock a single channel without affecting the other channels for the same user. If omitted, the suppression is removed across all channels.

Response

Suppression list updated.

statusstring
_messagestring

Example response

{
  "status": "ok",
  "_message": "1 record(s) has been deleted!"
}

Changes