Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeRequiredDefaultDescription
firstNameStringY
Prospect first name.
lastNameStringY
Prospect last name.
emailStringC
Prospect email address. Email or 1 phone number is required.
genderStringNM'M' for male, 'F' for female.
birthDateDate (M-d-YYYY)N
Prospect date of birth.
guestPassStartDate (M-d-YYYY)N
The start date of the prospect's guest pass.
guestPassEndDate (M-d-YYYY)N
The end date of the prospect's guest pass.
homePhoneStringC
Prospect home phone number with no formatting (e.g. 5555555555). Email or 1 phone number is required.
workPhoneStringC
Prospect work phone number. Email number with no formatting (e.g. 5555555555). Email or 1 phone number is required.
mobilePhoneStringC
Prospect mobile phone number . Email with no formatting (e.g. 5555555555). Email or 1 phone number is required.
address1StringN
Prospect address line 1.
address2StringN
Prospect address line 2.
cityStringN
Prospect full city.
stateStringN
Prospect 2 letter state code, i.e. PA for Pennsylvania.
zipStringN
Prospect zip code.
sourceStringN
The marketing source of the prospect, i.e. tv ad, mailer, internet, etc.
interestsString[]N

Array of Strings that should match the interests in your Club OS account. Ideal for content marketing.

Example: ["Personal Training","Smoothies","Tanning"]

notesStringN
Optional notes about the prospect.
salespersonIdIntegerN
The Club OS unique ID for the salesperson of the prospect being added. This salesperson will be assigned for the prospect's follow-up. 

barcode

StringN
The barcode of the prospect

billingSystemId

StringN
The id of the prospect that was created by the integrated billing system.
sendCampaignResponseEmailBooleanNfalseSend a campaign response email to this prospect. Only applies if the club is setup to receive these within Club OS.

sendWebleadResponseEmail

BooleanNfalseSend a Weblead response email to this prospect. Only applies if the club has this email configured within Club OS.

sendPresaleResponseEmail

BooleanNfalseSend a Presale response email to this prospect. Only applies if the club has this email configured within Club OS.

dontPushToBillingSystem

BooleanNfalseIf set to true, Club OS will not sync this prospect to the integrated billing system.

ignorePhoneNumberMatching

BooleanNfalseIf true, phone numbers will not be used to lookup an existing prospect.
smsOptOutBooleanNfalseIf true, the prospect will be opted out of text messages. 
emailOptOutBooleanNfalseIf true, the prospect will be opted out of email. 
walkInBooleanN
If true, the prospect will be created with an origin of walk-in.

...