Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
message

Delete a Broadcast

This endpoint is used to delete or stop a broadcast.

  • If the broadcast hasn't started yet, it will be deleted and the credits for this broadcast won't be charged.
  • If it's currently sending, it will stop immediately. Any messages that haven't been sent yet will be cancelled, and the credits for them will be refunded.
delete/message/broadcast/{broadcast_id}

Path parameters

broadcast_idstring required
Example:b25192d5-2370-4a69-b844-aae5e2bfae92

The broadcast_id returned when the broadcast was created. You have to provide the broadcast_id here in order to delete or stop it.

Response

Broadcast was deleted or stopped successfully.

broadcast_idstring
status'deleted' | 'stopped'

Example response

{
  "broadcast_id": "b25192d5-2370-4a69-b844-aae5e2bfae92",
  "status": "deleted"
}