REreacherapp
Automations

Update automation

Changed on

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}

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/automations/{automation_id}
  • Auth
    API key in header x-api-key and API key in header x-shop-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 business-hours send-window timezone (CORE-3031). Pass an IANA name to enable, or the empty string "" to disable (which also clears a custom window). Only valid for target_collab and dm automations.

business_hours_startstring nullable

Custom business-hours window start, 24-hour HH:MM, inclusive. Either bound may be sent alone (the other is kept); the effective pair must be complete and needs a business-hours timezone. "" for both restores 9am–9pm.

business_hours_endstring nullable

Custom business-hours window end, 24-hour HH:MM, exclusive. Must be after the start on the same day; 00:00 means midnight.

email_sent_per_dayinteger nullable
subjectstring nullable
bodystring nullable
scheduled_start_timestring nullable

Daily start time, 24-hour HH:MM, in scheduled_start_timezone (CORE-7900). Each day the automation waits until this wall-clock time before its first send, then runs until its daily limit — best effort, within about an hour, subject to TikTok rate limits. Mutually exclusive with business_hours_timezone. Initial outreach only; follow-up steps keep their own timing. Not supported on AI-enabled, CRM-group, or spark_code DM automations.

scheduled_start_timezonestring nullable

IANA timezone for scheduled_start_time (e.g. Europe/London).

Response

Successful Response

dry_runboolean
side_effectsobject nullable

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

Changes

  • 63ce74b30b5aRevision changes
    • info

      added the new optional request property ////

  • a905b640cf36Revision changes
    • info

      added the optional property / to the response with the status