API referenceAutomations

Manually enroll a contact

POST
/v1/automations/{id}/enroll

The automation must be active. Idempotent — UNIQUE(automation_id, contact_id) makes re-enrolling a no-op (200), a genuine enrollment is 201.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <key>. Looked up by SHA-256 hash (email_core::sha256_hex) against api_keys.hash; revoked keys and keys belonging to a suspended tenant are rejected. See the top-level Authentication section for permission levels.

Path Parameters

id*string

Request Body

application/json
  1. body
contact_id*string

Response Body

Already enrolled.

application/json
  1. response
automation_id?string
contact_id?string
enrolled?boolean
curl -X POST "https://example.com/v1/automations/string/enroll" \  -H "Content-Type: application/json" \  -d '{    "contact_id": "string"  }'
{  "automation_id": "string",  "contact_id": "string",  "enrolled": true}