Enroll in a benefit plan

post

https://api.wingspan.app/v3/platform/benefit-enrollments

Creates a new BenefitEnrollment for the caller's Account in the specified BenefitPlan. Status machine: Created -> Active -> PendingCancellation -> Cancelled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

planId

string

required

effectiveDate

date

dependents

array of objects

dependents

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Enrollment created

401Unauthenticated

403Forbidden

422Validation error

501This operation is not yet available