Skip to main content
POST
Invalidate a branch

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.

Path Parameters

policyId
string
required

Unique identifier for the policy

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

Unique identifier for the branch

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

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

Body

application/json
reason
enum<string>
required
Available options:
BROKER_REQUEST,
CUSTOMER_REQUEST,
FORKED,
ASSET_START_PASSED,
CONCURRENT_BRANCH_MERGED,
QUOTE_INVALIDATED,
PARTITION_DROPPED,
RENEWAL_REFUSED,
CRM_ABOVE_LIMIT,
TELEMATICS_SCORE_MISSING,
SIGNATURE_CANCELLED

Response

The response is of type object.