Skip to navigation
API ReferencePolicy Amendment Intents

Create a new policy amendment intent

Initiates a policy amendment (e.g. adding/removing dependents). The intent coordinates the amendment workflow including dependents sub-intent management, quote generation, employee confirmation, and provider processing.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

policy_idstringRequiredformat: "p_.+"

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.

Request

This endpoint expects an object.
amendment_reasonobjectRequired
The reason for the policy amendment.
requested_changeslist of objectsRequired
List of requested changes to the policy.

Response

OK
idstringformat: "pai_.+"

Unique identifier for the policy amendment intent. Prefixed with pai_.

policy_idstringformat: "p_.+"

The policy ID for which the amendment is requested. Prefixed with p_.

statusenum
Current status of the policy amendment intent.
amendment_reasonobject
The reason for the policy amendment.
requested_changeslist of objects
List of requested changes to the policy.
disclosureslist of objects
Disclosures associated with this intent.
objectstringOptionalRead-only
Object type identifier.
required_actionobjectOptional

Information about the required action if the intent status is action_required.

pending_confirmationobjectOptional

Information about the pending confirmation if the intent status is pending_confirmation.

processing_errorobjectOptional

Information about the processing error if the intent status is processing_error.

Errors

400
Bad Request Error
404
Not Found Error