Unsubscribe profile from resource
Description
Sends the information of the profile unsubscribtion to the platform. The subscription status changes to "Unsubscribed". Also this method allows to unsubscribe a profile from certain categories of resource.
Request URL
Method: POST
https://example.com/api/v1.1/profiles/message_unsub
Request parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
| rtoken | string | "abcdefghijklmnqrstuvwxyz" | Yes | Resource token |
| smid | string | "abcdefghijklmnqrstuvwxyz" | Yes | ID of the sent message |
| categories | array | ["cat_to_unsub"] | No | Resource category |
Request example
{
"token": "abcdefghijklmnqrstuvwxyz",
"rtoken":"2fHLS9YR9daS-a90b371eecc2952f",
"smid": "fGmXiWU9Y4NSIpCwl4QG6QXAAAQEQsQQQEQEAABCRAwJd3qH0QG6QXZ",
"categories": ["cat_to_unsub"]
}
Response example
{
"error": 0,
"error_text": "Successful operation",
"profile_id": "658997338e8f4032d92fd56d"
}
Response parameters
| Parameter | Type | Description |
|---|---|---|
| error | int | Error code |
| error_text | string | Error text |
| profile_id | string | Profile ID |