Samva
DashboardAPI
Api referenceTopics

Check topic subscriptions

Name exactly one contactId, email, or phone and a channel.

GET
/v1/topics/check

Name exactly one contactId, email, or phone and a channel. Returns effective status, using the topic default when no explicit subscription exists. topicIds is an optional comma-separated list. Addresses resolve within the requested namespace; an unknown address returns contactId null and the effective defaults.

Authorization

apiKey
x-api-key<token>

In: header

Query Parameters

contactId?|null
email?string|null
phone?string|null
namespaceId?|null
channel*"email"

Value in

  • "email"
topicIds?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/topics/check?channel=email"
{  "contactId": "string",  "channel": "email",  "topics": [    {      "topicId": "string",      "topicName": "string",      "status": "subscribed"    }  ]}