Cancel Transmission

This API lets you to cancel an already scheduled transmission.

Note: Transmission refers to a campaign. For example, transmission_id means the campaign's unique ID.

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/transmission/cancel/{transmission_id}

Content-Type

application/json

List of Response Body Attributes

Parameters	Data Type	Description
transmission_id	String	Unique ID of the transmission.
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.
errors	JSON Array	Contains the error details of the API such as 'code' and 'message'.

Possible Error Cases

Error Codes	Description
400018	Invalid transmission ID.
400019	The schedule time is overdue.
400020	Transmission has already been sent.
400023	Transmission has already been canceled.

Sample Response - Success

Copied{
  "response": {
    "code": 200003,
    "message": "Scheduled transmission has been successfully canceled"
  },
  "transmission_id": "1093639000425567264"
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 400018,
      "message": "Invalid transmission ID"
    }
  ]
}