REreacherapp
Automations

Create Target Collab automation

Changed on

Create a Target Collab (TC) invitation automation with optional follow-up DMs. Required: read_write scope, Idempotency-Key header. Pass X-Dry-Run: true to validate without persisting.

post/automations/target-collab

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/automations/target-collab
  • 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
ai_enabledboolean
end_datestring date nullable
auto_resolve_conflicts'SKIP_ALL' | 'MOVE_NOT_ACCEPTED' | 'MOVE_ALL'

How the runtime handles creators who already have a pending TC invite from another automation. SKIP_ALL leaves them untouched; MOVE_NOT_ACCEPTED (default — matches portal-created automations) re-targets creators whose prior invite was never accepted; MOVE_ALL re-targets regardless of prior invite state. Maps to config.AUTO_RESOLVE_CONFLICTS.

is_evergreenboolean

When true, the automation continuously re-evaluates its creators_to_include.filters and queues newly-qualifying creators on each run. Has no effect for lists mode (lists are static) or crm_group mode (CRM groups are inherently evergreen). Maps to top-level Automations.is_evergreen column.

business_hours_timezonestring nullable

When set, the runtime restricts initial-outreach delivery to the business-hours window in this IANA timezone (e.g. America/Los_Angeles): 9am–9pm, or business_hours_start – business_hours_end when those are set. Follow-up steps keep their own timing. Null disables the restriction — messages can fire at any time within the schedule's daily window. Distinct from schedule.timezone, which governs when the automation evaluates its queue (per CORE-3031).

business_hours_startstring nullable

Custom business-hours window start, 24-hour HH:MM in business_hours_timezone, inclusive. Set together with business_hours_end; omit both for 9am–9pm.

business_hours_endstring nullable

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

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

  • a905b640cf36Revision changes
    • info

      added the optional property / to the response with the status

  • 2840b044a7daRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property