v33

latestOpenAPI 3.0.2raw.githubusercontent.com2026-03-142353151.8 KB
Suppression List

Get Suppression List

The Suppression List API enables you to manage users who should be excluded from receiving communications on specific channels.<br/><br/>This API enables you to retrieve the list of all suppressed users across various channels.

get/{WSID}/suppressions

Path parameters

WSIDstring required

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

Response

Suppression list fetched.

_idstring

Unique identifier of the suppression record

destinationstring

Phone number or email of the suppressed user

distinct_idstring

Unique identifier (used as an alternative to destination)

channelstring

Communication channel (e.g., sms, whatsapp, email)

descriptionstring

Reason or tag for suppression (e.g., "DND", "Testing").

created_atstring

Timestamp when the suppression was created

expiry_tsstring

Optional timestamp for expiration of suppression

Example response

[
  {
    "_id": "68763be4b8cee01156d9fa8a",
    "destination": "919XXXXXXXX",
    "distinct_id": "XXXX-XXX-XXXX",
    "channel": "sms",
    "description": "DND",
    "created_at": "2025-07-15T16:20:16.302+05:30",
    "expiry_ts": "2025-07-15T16:25:16.302+05:30"
  }
]