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:
- URL: https://signals.smarte.pro/signals/v1/domains/unsubscribe
- Method: POST
Input Parameters
Required Headers:
Header | Value Type | Required | Description |
---|---|---|---|
Api-key | string | Yes | API key |
Content-Type | string | yes | Must be application/json |
Request Body Parameters:
Parameter | Type | Required | Description |
---|---|---|---|
comp_domain | string | Yes | Company Domain which needs to be unsubscribed |
comp_guid | string | Yes | GUID 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"
}