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": "fa770c92-a1f1-4375-9a7b-e13d9aac0786",
_10
"action": "unsubscribe"
_10
}

Example of successful response


_10
{
_10
"subscription_id": "fa770c92-a1f1-4375-9a7b-e13d9aac0786"
_10
}

Example of error response


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

Request fields

NameTypeMandatoryDescription
subscription_idUUIDYESUnique identifier of the subscription
actionSTRINGYESAction to perform. Must be unsubscribe to initiate a unsubscription