Skip to main content

Unsubscribe API

The Unsubscribe API provides the capability to stop following a specific domain, effectively halting the delivery of all associated signals and updates to the associated key.

Endpoint Details:

Input Parameters

Required Headers:

HeaderValue TypeRequiredDescription
Api-keystringYesAPI key
Content-TypestringyesMust be application/json

Request Body Parameters:

ParameterTypeRequiredDescription
comp_domainstringYesCompany Domain which needs to be unsubscribed
comp_guidstringYesGUID of Company which needs to be unsubscribed

Sample

Request

curl --location 'https://signals.smarte.pro/signals/v1/domains/unsubscribe' \
--header 'Content-Type: application/json' \
--header 'Api-Key: Id9h4v9sNYxhC6CxMCTm4i2gHC9u/CeGp1mxXoTA3vs=' \
--data '{
"company_guid": "1C2B1CBDE4A2DB11",
"company_domain": "sanofi.com"
}'

Success Response

{
"status": "success",
"code": 200,
"company_guid": "1C2B1CBDE4A2DB11",
"company_domain": "http://sanofi.com ",
"message": "Company domain 'http://sanofi.com ' successfully unsubscribed"
}