Automations

email_update_automation

Update an automation's trigger, filter, priority, exit event, or name.

write email_update_automation

Update an automation's trigger, filter, priority, exit event, or name. Trigger/filter changes affect FUTURE enrollments only. triggerFilter accepts a flat array (all AND) OR a nested {op:'and'|'or', conditions:[...]} group — the same shapes email_create_automation takes — so OR filters can be updated, not just created. Pass null to clear. triggerSegmentId retargets the automation at a segment (expands to the $segment_entered trigger) — don't combine it with triggerEvent/triggerFilter. Steps are edited with email_add_automation_steps / email_update_automation_step / email_remove_automation_step.

Parameters

ParameterTypeRequiredDescription
automationstringYesAutomation id or exact name.
namestringNo
triggerEventstringNo
triggerFilterobject[] | any | nullNo
triggerSegmentIdstringNoRetarget at a segment's entry ($segment_entered). Excludes triggerEvent/triggerFilter.
triggerScheduledaily | weekly | monthly | nullNoSweep cadence for a $scheduled automation. Null clears it (and stops the sweeps).
priorityintegerNo
exclusivebooleanNo
exitEventsstring[] | nullNoEvents that end a running run, ORed. Replaces the singular exitEvent.
exitEventstring | nullNo
allowReenrollmentbooleanNo
reenrollmentCooldownSecondsintegerNoMinimum seconds before the same contact can re-enter (0 = none). The middle ground between re-entering every time and never again — note that "never" also counts CANCELED runs, so an automation exiting on conversion would otherwise burn out every contact who converts once. Ignored when allowReenrollment is false.
projectIdstringNoTarget company (project id) — required on project-scoped tools. Call email_list_projects to enumerate companies.

On this page