Skip to main content
POST
Create a new referral

Authorizations

X-ZeroPath-API-Token-Id
string
header
required
X-ZeroPath-API-Token-Secret
string
header
required

Body

application/json
firstName
string
required

First name of the referred person

Required string length: 1 - 100
lastName
string
required

Last name of the referred person

Required string length: 1 - 100
email
string<email>
required

Email address of the referred person

mobilePhone
string
required

Mobile phone number of the referred person

Required string length: 10 - 20
companyName
string
required

Company name of the referred person

Required string length: 1 - 200
referrerFirstName
string
required

First name of the person making the referral

Required string length: 1 - 100
referrerLastName
string
required

Last name of the person making the referral

Required string length: 1 - 100
referrerEmail
string<email>
required

Email address of the person making the referral

type
enum<string>
required

Type of referral

Available options:
DEMO
notes
string

Optional notes about the referral

Maximum string length: 1000

Response

Referral created successfully

success
boolean
required

Whether the referral was created successfully

referralId
string<uuid>
required

Unique identifier of the created referral