transmissions

Cancel a transmission

Cancels a transmission that has not finished. Cancelling one that already completed, failed or was cancelled is a no-op that returns its current status. A send in progress stops cooperatively, so messages already dispatched are still delivered.

post/api/v1/transmissions/{transmission_id}/cancel

Request

  • Base URL: https://api.izap.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.izap.ai/api/v1/transmissions/{transmission_id}/cancel
  • Auth: HTTP bearer

Path parameters

transmission_idstring uuid required

Headers

business-idstring uuid required

Response

Successful Response

transmission_idstring uuid required
namestring required
statusstring required
transmission_typestring required
template_namestring nullable required
total_recipientsinteger required
sent_countinteger required
failed_countinteger required
pending_countinteger required
progress_pctnumber required
scheduled_atstring date-time nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required
createdstring date-time nullable
business_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.