Skip to main content
POST
Send Cancellation Warning
Send a warning to the service’s client email address using your active cancellation-warning template. Requires admin:full and a nonblank warningReason. This action sends an email. It does not cancel the service or schedule a cancellation.

Before sending

The service must belong to your broker and must not be cancelled or terminated. It needs a client email address, and your broker needs an active Cancellation Warning template.

Understand the result

HTTP 200 with request_status: "approved" means the email send succeeded. The API then attempts to save a request-history entry. If that entry cannot be saved, request_id can be null even though the email was sent.
This endpoint does not support X-Idempotency-Key. Repeating a call can send another email. Confirm the outcome before retrying a timeout or error.
Sandbox calls return a simulated warning record without sending email or writing request history.

Endpoint errors

For authentication, permissions, rate limits, and safe retries, see Errors and Retries.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Path Parameters

service_number
integer<int64>
required

Public service number parsed as a base-10 integer.

Body

application/json
warningReason
string
required

Nonblank reason for the warning. Leading and trailing spaces are removed.

Pattern: \S

Response

Warning email sent, or simulated in Sandbox Mode. The request-history entry is best-effort.

success
boolean
required
data
object
required
message
string
pagination
object
Last modified on September 8, 2026