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

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

Example of successful response

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

Example of error response

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

Request fields

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