OpenSequence
DocsAPI referenceSDKs and CLIReference
Enrollments

Preflight: conflicts, exclusions, capacity; no writes

POST
/v1/sequences/{id}/enrollments:preview

Authorization

projectKey
headerAuthorizationBearer <token>

A project API key (sk_live_…) with read, enroll or admin scope.

Path Parameters

id*string
Length1 <= length <= 128

Request Body

application/json
  1. body
contacts*array<|>
Items1 <= items <= 5000
sender*string
Length1 <= length
version?string
enrolled_by?string
Lengthlength <= 64
enrolled_by_kind?string
Value in"user""agent""system"
mode?string
Value in"live""dry_run"

Response Body

Default Response

application/json
  1. response
success*true
Value intrue
data*unknown
meta*
curl -X POST 'http://localhost:8080/v1/sequences/string/enrollments:preview' \  -H 'Content-Type: application/json' \  -d '{  "contacts": [    "string"  ],  "sender": "string"}'
{  "success": true,  "data": null,  "meta": {    "request_id": "string",    "next_cursor": "string"  }}