Save automation workflow schedule

Schedule when an automation workflow is enabled (startAt), disabled (endAt), or both.
The request replaces the whole schedule. Saving a schedule does not change isEnabled.

  • startAt can be set only for a disabled workflow. At startAt the workflow is enabled the same
    way as with the enable action. If the workflow has validation errors at that time, it stays
    disabled and startFailedAt is set.
  • endAt requires contactsInWorkflow, which works the same way as in the disable action.
  • Times are stored in UTC with minute precision and are applied within a few minutes.
  • Enabling the workflow manually removes startAt; disabling it manually removes the schedule.

warnings lists the problems that would currently stop the workflow from being enabled: workflow
validation errors and account problems such as blocked email sending. The schedule is saved
regardless. When warnings is not empty, the automatic start fails unless they are resolved
before startAt; warningsDetail says so with the date.

Scopes:
automations.write

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.

Path Params
string
required

Automation workflow ID (24 character hexadecimal)

Body Params

Schedule

Replaces the whole schedule of an automation workflow. At least one of startAt and endAt is required, and both must be in the future. The contactsInWorkflow field determines what happens at endAt to contacts currently progressing through the workflow: - "keep": contacts remain in the workflow and continue through the remaining blocks until completion. No new contacts enter. - "exit": all contacts are immediately removed from the workflow.

string
enum

What to do at endAt with contacts currently in the workflow. Required when endAt is set.

Allowed:
string

Time to disable the workflow (RFC 3339). Seconds are truncated. Must be after startAt.

string

Time to enable the workflow (RFC 3339). Seconds are truncated. Not allowed for an enabled workflow.

Headers
string
required
Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

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