NameDescriptionTypeAdditional information
firstName

Referral first name. Optional

 string

None.
lastName

Referral last name. Optional

 string

None.
email

Referral email address. Optional

 string

None.
phoneNumber

Customer’s phone number. Optional

 string

None.
preferredContact

The preferred means to contact the referral. The values an be 'email', 'callMorning', 'callAfternoon', or 'callEvening'. Optional.

 string

None.
externalIdentifier

Unique external identifier you can use to later reference the referral. (i.e. another system's unique identifier, like a order number or customer ID). Optional.

 string

None.
amount

Passed order amount/total. Optional.

 decimal number

None.
companyName

Company name. Optional.

 string

None.
note

Any note or other information you want to see tied to the Referral. Optional.

 string

None.
publicNote

Any note that you want to be publicly tied to the Referral. Optional.

 string

None.
customOption1Name

Custom option 1 name. Optional.

 string

None.
customOption2Name

Custom option 2 name. Optional.

 string

None.
customText1Name

Custom option 2 name. Optional.

 string

None.
customText2Name

Custom text 2 name. Optional.

 string

None.
customText3Name

Custom text 3 name. Optional.

 string

None.
customOption1Value

Custom value tied to customoption1name. Optional.

 string

None.
customOption2Value

Custom value tied to customoption2name. Optional.

 string

None.
customText1Value

Custom value tied to customtext1name. Optional.

 string

None.
customText2Value

Custom value tied to customtext2name. Optional.

 string

None.
customText3Value

Custom value tied to customtext3name. Optional.

 string

None.
status

Status of the Referral. The value can be "pending", "qualified", "approved", "denied". Optional.

 string

None.
addressLine1

Referral address line 1. Optional.

 string

None.
addressLine2

Referral address line 2. Optional.

 string

None.
city

Referral city name. Optional.

 string

None.
state

Referral state, must be a valid state name or abbreviation. Optional.

 string

None.
postalCode

Referral postal code. Optional.

 string

None.
province

Referral province name. Optional.

 string

None.
country

Referral country name. Optional.

 string

None.
recruiterAssignedId

RecruiterId currently assigned to the referral. Optional.

 globally unique identifier

None.