Skip to main content
POST
/
customers
/
policies
/
{policyId}
Create a customer on an existing policy
curl --request POST \
  --url https://api.example.com/customers/policies/{policyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "customerId": "<string>"
}

Path Parameters

​
policyId
string
required

The policy id to attach the new customer to

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
branchId
string

Optional: the branchId

Body

application/json
​
role
string
required

The role of the customer on the policy

​
customFields
object[]

Custom fields for the customer

Response

​
customerId
string
required

The created customer id