Send Cancellation Warning
Email a client a cancellation warning without cancelling their service.
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
HTTP200 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.
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
Send the API key in the Authorization bearer header. Production keys begin with sk_live_.
Path Parameters
Public service number parsed as a base-10 integer.
Body
application/json
Nonblank reason for the warning. Leading and trailing spaces are removed.
Pattern:
\SLast modified on September 8, 2026

