Skip to navigation

Reject an enrolment intent

Rejects an enrolment_intent that is in PendingConfirmation, ActionRequired, or CoverageOptionsRequired status. This transitions the enrolment intent to NotUndertaken 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.

Response

No Content

Errors

400
Bad Request Error
404
Not Found Error