Skip to main content
Version: v71

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

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
rtokenstring"abcdefghijklmnqrstuvwxyz"YesResource token
smidstring"abcdefghijklmnqrstuvwxyz"YesID of the sent message
categoriesarray["cat_to_unsub"]NoResource category

Request example

{
"token": "abcdefghijklmnqrstuvwxyz",
"rtoken":"2fHLS9YR9daS-a90b371eecc2952f",
"smid": "fGmXiWU9Y4NSIpCwl4QG6QXAAAQEQsQQQEQEAABCRA",
"categories": ["cat_to_unsub"]
}

Response example

{
"error": 0,
"error_text": "Successful operation",
"profile_id": "658997338e8f4032d92fd56d"
}

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
profile_idstringProfile ID