v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Dependents Management Intents

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.

post/dependents_management_intents/{dependents_management_intent_id}/cancel

Path parameters

dependents_management_intent_idstring required
Example:dmi_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