Skip to main content
POST
Send a formal notice

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Body

application/json
policyId
string
required

The ID of the policy to generate the formal notice for

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
customerId
string
required

The ID of the customer to generate the formal notice for

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
whenAt
string<date-time>

Optional: the whenAt datetime

Response

200 - application/json

Execute the formal notice workflow

workflowRunId
string
required

The ID of the formal notice that was generated

Pattern: ^workflow_run(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$