v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Enrolment Intents

Reject an enrolment intent

Rejects an enrolment_intent that is in PendingConfirmation, ActionRequired, or CoverageOptionsRequired status. This transitions the enrolment intent to NotUndertaken status.

post/enrolment_intents/{enrolment_intent_id}/reject

Path parameters

enrolment_intent_idstring required
Example:ei_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

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