Reschedule Transmission

This API allows you to reschedule a transmission at a time of your choice.

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

Request Type

  • PUT

Request URL

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

Content-Type

application/json

List of Request Body Attributes

Parameters

Data Type

Description

optionsJSONObjectOptions to customize your transmission.
schedule_atLongUTC timestamp in milliseconds that represents the time at which the transmission must be sent

List of Response Body Attributes

ParametersData TypeDescription
transmission_idStringUnique ID of the transmission.
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
errorsJSON ArrayContains the error details of the API such as 'code' and 'message'.

Possible Error Cases

Error Codes

Description

400017Schedule time is lesser than current time.
400018Invalid transmission ID.
400020Transmission has already been sent.
400021The transmission has been canceled. Please create a new transmission.
400022Schedule time not provided.

Sample Request Payload

Copied{
  "options": {
    "schedule_at": 1728472166000
  }
}

Sample Response - Success

Copied{
  "response": {
    "code": 200001,
    "message": "Your transmission has been scheduled successfully"
  },
  "transmission_id": "1093639000425567264"
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 400017,
      "message": "Schedule time is lesser than current time"
    }
  ]
}