Skip to main content
DELETE
/
v1
/
channels
/
{channelId}
/
cancel
curl --request DELETE \
  --url https://api.hubmessage.io/v1/channels/{channelId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancelReason": "Customer closed the company"
}
'
{
  "error": 400,
  "message": "cancel query param is required"
}

​
Overview

Requests the cancellation of a channel subscription. Cancellation is not immediate — the channel enters CANCELLATION_PROCESS status and remains active until the end of the already-paid period. After that period, the status changes to CANCELED. The cancel=true query parameter is required as an explicit cancellation confirmation. The cancelReason field in the body is optional, but recommended for auditing purposes.
This endpoint requires the ENTERPRISE role on your account.

​
Status after cancellation

StatusDescription
CANCELLATION_PROCESSCancellation requested, channel still active until end of period
CANCELEDChannel effectively cancelled and deactivated
Cancellation cannot be undone via API. To reactivate the channel, a new subscription must be initiated via Subscribe channel.
The channelId is obtained from the Create channel endpoint.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Path Parameters

​
channelId
string
required

Channel ID (obtained via Create channel)

Example:

"019E4C54B1B375A28970B605CA9B03C3"

Query Parameters

​
cancel
boolean
required

Must be true to confirm the cancellation

Example:

true

Body

application/json
​
cancelReason
string

Cancellation reason (optional, but recommended for auditing)

Example:

"Customer closed the company"

Response

Cancellation requested successfully. No content returned.