Skip to main content

​
Method

GET /v1/comms/suppressions

​
Query Parameters

​
channel
string
email, sms, whatsapp, telegram, facebook_messenger, instagram_dm, twitter_dm, linkedin_message, phone, push_notification, in_app, webhook

​
Headers

​
Authorization
string
required
Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)
​
X-Workspace-Id
string
required
Workspace identifier (UUID)

​
Request Example

cURL
curl "https://api.voyantcloud.com/v1/comms/suppressions?channel=email" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Workspace-Id: WORKSPACE_UUID"
Node.js
await fetch("https://api.voyantcloud.com/v1/comms/suppressions?channel=email", {
  headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}`, "X-Workspace-Id": process.env.WORKSPACE_ID },
})
Python
import os, requests
requests.get(
  "https://api.voyantcloud.com/v1/comms/suppressions",
  params={"channel":"email"},
  headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}", "X-Workspace-Id": os.environ["WORKSPACE_ID"]}
)

​
Response

{ "data": [ { "id": "sup_123", "channel": "email", "value": "user@example.com", "reason": "bounce" } ] }