REreacherapp
Automations

Stop email automation

Changed on

Stop an email automation so it stops sending. Requires read_write scope and an Idempotency-Key; X-Dry-Run: true previews without writing.

post/automations/email/{email_automation_id}/stop

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/automations/email/{email_automation_id}/stop
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Path parameters

email_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