Skip to main content
POST
Create 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}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

Body

application/json
branchType
enum<string>
required

Branch type

Available options:
BASE,
NEW_BUSINESS,
MTA,
RENEWAL,
REPRICING
name
string

Optional: Name of the entity

branchSubType
enum<string>

Branch sub type

Available options:
CREATE_ADDITIONAL_COMPONENTS,
DRIVEQUANT

Response

type
string
required

Type of the created object

id
string
required

Unique identifier for the created object

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