Automations

Update automation

Partial update across all 4 types. Cannot change automation_type, shop, lifecycle state, or system fields. Idempotency-Key optional; X-Dry-Run: true supported.

patch/automations/{automation_id}

Path parameters

automation_idinteger required

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

automation_namestring nullable
ai_enabledboolean nullable
is_evergreenboolean nullable
end_datestring date nullable
business_hours_timezonestring nullable

Set or change the 9am–9pm send-window timezone (CORE-3031). Pass an IANA name to enable, or the empty string "" to disable. Only valid for target_collab and dm automations.

email_sent_per_dayinteger nullable
subjectstring nullable
bodystring nullable

Response

Successful Response

dry_runboolean
side_effectsobject nullable

Backend side-effects, e.g. {'crm_group_created': 'uuid-...'} for sample_request creates.

Changes

No recorded changes to this endpoint across all 1 revision of this API.