REreacherapp
Automations

Start automation

Changed on

Transition automation to running. Idempotent — already-running returns 200. Rejects with 422 AUTOMATION_NOT_STARTABLE when the automation can never run as configured (no schedule day with maxCreators > 0, valid_until/end_date already passed, or a sample-request automation's include or always-approve list was deleted) — this prevents the 'start succeeded but nothing ever sends' trap.

post/automations/{automation_id}/start

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/automations/{automation_id}/start
  • 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

Response

Successful Response

dry_runboolean
side_effectsobject nullable

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

Changes

  • a905b640cf36Revision changes
    • info

      added the optional property / to the response with the status

  • 291230805105Revision changes
    • breaking

      the / response's property type changed from string to no type for status

    • info

      added subschema #1 subschema #2 to the / response property anyOf list for the response status