LLM Notice: This documentation site supports content negotiation for AI agents. Request any page with Accept: text/markdown or Accept: text/plain header to receive Markdown instead of HTML. Alternatively, append ?format=md to any URL. All markdown files are available at /md/ prefix paths. For all content in one file, visit /llms-full.txt
Skip to main content

Unsubscribe message format

Unsubscribe requests must be sent as JSON in text frames, one request per frame.

Example of unsubscribe request​


_10
{
_10
"subscription_id": "some-id-1",
_10
"action": "unsubscribe"
_10
}

Example of successful response​


_10
{
_10
"subscription_id": "some-id-1",
_10
"action": "unsubscribe"
_10
}

Example of error response​


_10
{
_10
"error": {
_10
"code": 404,
_10
"message": "subscription not found"
_10
}
_10
}

Request fields​

NameTypeRequiredDescription
subscription_idSTRINGYESUnique identifier of the subscription
actionSTRINGYESAction to perform. Must be unsubscribe to initiate a unsubscription
Rate this page