POST/hyax-api/v1/sequences/enroll

Enroll in sequence

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

Field	Required	Description
email	Yes	Person's email (must exist in team)
sequenceId	Yes	Email sequence ID

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X POST 'https://platform.hyax.com/hyax-api/v1/sequences/enroll' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "[email protected]",
    "sequenceId": "clx_sequence_id"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "enrolled": true,
    "subscriptionId": "clx…",
    "peopleId": "clx…",
    "sequenceId": "clx_sequence_id"
  }
}