Skip to navigation

Cancel the dependents management intent

Cancels the dependents_management_intent in case an employee decides not to proceed with changes to their dependents. Canceling is only allowed from action_required status. If the intent is already canceled, the operation succeeds without changes. After canceling, a new dependents management intent can be created from the parent intent.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

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