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
GET
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 details of the transmission including subject, name, etc. |
subject | String | The email's subject line. |
from | String | A sender address. |
transmission_name | String | A name for the email. |
status | String | Status of the transmission; if it has been sent or bounced. |
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'. |
open_tracking | String | Specifies whether open tracking was enabled or disabled for this transmission. |
click_tracking | String | Specifies whether click tracking was enabled or disabled for this transmission. |
schedule_at | Long | The scheduled time for the transmission to be sent. |
sent_time | Long | The time when the transmission was actually sent. |
reply_to | String | The email address to which the subscribers reply. This is an optional parameter |
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"
}
]
}