Skip to main content
POST
/
invite
cURL
curl --request POST \
  --url https://api.example.com/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyId": "<string>",
  "customerId": "<string>",
  "type": "COMPANY",
  "branchId": "<string>",
  "email": "<string>"
}
'
{
"token": "<string>"
}

Body

application/json
policyId
string
required

Policy id

customerId
string
required

Customer id

type
enum<string>
required

Invite type

Available options:
COMPANY,
EMPLOYEE,
RETAIL_TO_RETAIL_BROKER,
POLICY_OWNER,
REINVITE,
ANONYMOUS,
WHOLESALE_TO_RETAIL_BROKER
branchId
string

Branch id

email
string

Email address

Response

token
string

Token