Update campaign schedule

Use this endpoint to update the schedule of an existing campaign.

Path Params
string
required

Specify the UUID of the campaign to update.

Body Params

Specify the schedule details for the campaign.

date-time
required

Specify the campaign start time in ISO 8601 format.

Default: current time (the campaign is launched immediately).

date-time

Specify the campaign end time in ISO 8601 format.

Default: null (the campaign runs forever).

string

Applicable to segment-triggered campaigns.

Options: daily, continuously.

repeating_schedule_attributes
object

For recurring campaigns. Contains recurrence config.

Responses

400

Bad Request - The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.

401

Unauthorized - API authentication failed due to an invalid or missing API key.

403

Forbidden - The API key does not have sufficient permissions to perform this action.

404

Not Found - The specified campaign was not found. Verify the campaign UUID.

422

Unprocessable Entity - The campaign cannot be paused due to its current status (e.g., already completed or archived). One or more scheduling parameters may be invalid (if applicable).

429

Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500

Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502

Bad Gateway - The server received an invalid response. Retry the request.

503

Service Unavailable - The service is temporarily unavailable. Try again later.

504

Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json