Enroll leads

Authentication

Bearer owner API key required. Send:

• Authorization: Bearer bs_live_…
• X-Workspace-Id: <workspace-uuid> (workspace you own)

Description

Enroll leads by id and/or segment.

Request body

JSON unless noted.

leadIds (max 500) and/or segmentId — at least one required.

Response

JSON object on success unless this route returns a file download (Content-Disposition: attachment). Rate limit headers are included on authenticated responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Errors

• 400 — validation or business rule failure ({ "error": string }, sometimes issues[])
• 401 — missing or invalid API key
• 403 — suspended account, wrong workspace, or insufficient role
• 404 — resource not found in workspace
• 429 — rate limit (code: "RATE_LIMIT_EXCEEDED", Retry-After header)
• 500 — unexpected server error

Example

curl -sS -X POST "https://app.boltsequencer.com/api/campaigns/[id]/enroll" \
  -H "Authorization: Bearer bs_live_YOUR_KEY" \
  -H "X-Workspace-Id: YOUR_WORKSPACE_UUID"
  -H "Content-Type: application/json" \
  -d '{}'