Automations

Create Email automation

Changed on

Create an outbound email automation. Different recipient model from outreach — use selection_mode: mailing_list (with vault list IDs or upload emails inline), selection_mode: filters (creator search criteria), or selection_mode: crm_stage (target a CRM/funnel stage — the server resolves the stage's creators to their email addresses). For crm_stage, creators with no email on file are skipped, and the response reports the reachable audience versus the stage size under config.recipient_coverage; a stage that resolves to no reachable emails is rejected. selection_mode: crm_group (with crm_group_id) targets a CRM group of this shop: the audience stays live, so every send run emails the group's current members that have an email on file. A group with no reachable emails is rejected; a group from another shop is a 404 CRM_GROUP_NOT_FOUND. An email_account_id may back several active email automations. Each one adds to that inbox's daily send volume, and the daily cap is applied per automation, so heavy reuse risks provider throttling or spam classification.

post/automations/email

Request

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

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable
X-Created-Viastring nullable

Request body

automation_namestring required
email_account_idinteger required

Pre-connected email account. May back several active email automations; each one adds to that inbox's daily send volume.

subjectstring required
bodystring required

HTML or plaintext.

selection_mode'mailing_list' | 'filters' | 'crm_stage' | 'crm_group' required
crm_group_idstring nullable

CRM group to email, for selection_mode: crm_group. The group must belong to this shop. Unlike crm_stage, the audience is live: every send run emails the group's current members that have an email on file.

email_sent_per_dayinteger nullable

Maximum emails this automation sends per day from its connected inbox. Applied per automation, so multiple automations on the same inbox each get their own daily budget. Omit to use the default of 40 emails per day.

Response

Successful Response

dry_runboolean
side_effectsobject nullable

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

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the new optional request property

    • info

      added the new crm_group enum value to the request property