Get Transmission Details

This API lets you to obtain the details of a particular 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/{transmission_id}

Content-Type

application/json

List of Response Body Attributes

Parameters	Data Type	Description
transmission_details	JSON Object	Contains the metadata and delivery configuration of the requested transmission.
subject	String	The email subject used for the transmission.
from	String	The sender address used for the transmission.
reply_to	String	The reply-to address used for the transmission, if provided.
transmission_name	String	User-defined name of the transmission.
status	String	Current delivery status of the transmission. Possible values include (but are not limited to): Sent, Scheduled, Cancelled.
sent_time	Long	Timestamp representing when the message was sent (in milliseconds since epoch)
options	JSON Object	Contains delivery configuration options applied to the transmission.
options.open_tracking	String	Indicates whether open tracking was enabled for this transmission. Values: enabled/disabled
options.click_tracking	String	Indicates whether click tracking was enabled for this transmission. Values: enabled/disabled
options.schedule_at	Long	Timestamp (in milliseconds) indicating when the transmission is scheduled to be sent.
response	JSON Object	Contains the API-level response information indicating whether the request succeeded or failed.
response.code	Integer	Success or failure code.
response.message	String	Success or failure message returned by the API.
errors	JSON Array	Contains one or more objects describing the failure. Each error object contains a code and a message.

Possible Error Cases

Error Codes	Description
400018	Invalid transmission ID.

Sample Response - Success

Copied{
  "transmission_details": {
    "subject": "Hello $[first_name|Customer]$",
    "from": "aron@zylker.com",
    "reply_to": "aron@reply.zylker.com",
    "transmission_name": "My first Email API Campaign",
    "status": "Sent",
    "sent_time": 1728472166000,
    "options": {
      "open_tracking": "disabled",
      "click_tracking": "disabled"
    }
  },
  "response": {
    "code": 200004,
    "message": "Successfully obtained the transmission details"
  }
}

Sample Response - Failure

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