Skip to navigation
API ReferenceEnrolment Intents

Submit coverage selections for an enrolment intent

Submits plan coverage option selections for an enrolment intent in the coverage_options_required status.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

enrolment_intent_idstringRequiredformat: "ei_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request

This endpoint expects an object.
coverage_selectionslist of objectsRequired

Coverage option selections for policy-scoped configurations.

Response

No Content

Errors

400
Bad Request Error
404
Not Found Error