Sign in
Sequences

Preview bulk enrollment eligibility

Preview-only check of up to 500 People against this Sequence's enrollment policy (already-enrolled, active-sequence conflicts, concurrent-enrollment limit), backed by the People enrollment read projection rather than a live Postgres check per Person. Requires a USER API key. The authoritative check still runs when an enrollment is actually attempted, so a stale projection can never let an over-limit enrollment through. Instances in a Sequence the caller cannot view are returned as { instanceId, restricted: true }.

post/public/v1/sequences/{sequenceId}/enrollments/eligibility

Path parameters

sequenceIdnumber nullable
Example:101

Request body

personRowIdsstring[] required

Example request

{
  "personRowIds": [
    "example"
  ]
}

Response

Per-person eligibility results

Example response

{
  "results": [
    {
      "personRowId": "example",
      "code": "ALREADY_ENROLLED",
      "activeCount": 1,
      "maxAllowed": 1,
      "activeInstances": [
        {
          "instanceId": 1,
          "sequenceId": 1,
          "sequenceName": "example"
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.1