← Home
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

FieldRequiredDescription
email Required Person's email (must exist in team)
sequenceId Required Email sequence ID

Request 

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"
  }'

Response 

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