/prospects
GET /prospects
Verifies that the given prospect userId exists in Club OS and you have access to it. Â
GETÂ https://api.club-os.com/prospects?clubLocationId=[clubLocationId]&userId=[userId]
Parameters
The following fields must be included as parameters in the URL of the request.
Variable | Type | Description |
---|---|---|
clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
userId | Integer | The Club OS unique id for the prospect you are requesting. |
Response Message
The following message will be returned when the request succeeds.
Message | Description |
Prospect was found | The prospect was found and you have access to them. |
POST /prospects
Add a prospect to the system.
POSTÂ https://api.club-os.com/prospects?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
Variable | Type | Description |
---|---|---|
clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
The following fields must be included in the body of the HTTP request as a valid JSON string.
Property | Type | Required | Default | Description |
---|---|---|---|---|
firstName | String | Y | Prospect first name. | |
lastName | String | Y | Prospect last name. | |
String | C | Prospect email address. Email or 1 phone number is required. | ||
gender | String | N | M | 'M' for male, 'F' for female. |
birthDate | Date (M-d-YYYY) | N | Prospect date of birth. | |
guestPassStart | Date (M-d-YYYY) | N | The start date of the prospect's guest pass. | |
guestPassEnd | Date (M-d-YYYY) | N | The end date of the prospect's guest pass. | |
homePhone | String | C | Prospect home phone number with no formatting (e.g. 5555555555). Email or 1 phone number is required. | |
workPhone | String | C | Prospect work phone number with no formatting (e.g. 5555555555). Email or 1 phone number is required. | |
mobilePhone | String | C | Prospect mobile phone number with no formatting (e.g. 5555555555). Email or 1 phone number is required. | |
address1 | String | N | Prospect address line 1. | |
address2 | String | N | Prospect address line 2. | |
city | String | N | Prospect full city. | |
state | String | N | Prospect 2 letter state code, i.e. PA for Pennsylvania. | |
zip | String | N | Prospect zip code. | |
source | String | N | The marketing source of the prospect, i.e. tv ad, mailer, internet, etc. | |
interests | String[] | N | Array of Strings that should match the interests in your Club OS account. Ideal for content marketing. Example: ["Personal Training","Smoothies","Tanning"] | |
notes | String | N | Optional notes about the prospect. | |
salespersonId | Integer | N | 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 | String | N | The barcode of the prospect | |
billingSystemId | String | N | The id of the prospect that was created by the integrated billing system. | |
sendCampaignResponseEmail | Boolean | N | false | Send a campaign response email to this prospect. Only applies if the club is setup to receive these within Club OS. |
sendWebleadResponseEmail | Boolean | N | false | Send a Weblead response email to this prospect. Only applies if the club has this email configured within Club OS. |
sendPresaleResponseEmail | Boolean | N | false | Send a Presale response email to this prospect. Only applies if the club has this email configured within Club OS. |
dontPushToBillingSystem | Boolean | N | false | If set to true, Club OS will not sync this prospect to the integrated billing system. |
ignorePhoneNumberMatching | Boolean | N | false | If true, phone numbers will not be used to lookup an existing prospect. |
smsOptOut | Boolean | N | false | If true, the prospect will be opted out of text messages. |
emailOptOut | Boolean | N | false | If true, the prospect will be opted out of email. |
walkIn | Boolean | N | If true, the prospect will be created with an origin of walk-in. |
Response Messages
One of the following messages will be returned when the request succeeds.
Message | Description |
Prospect Created | Prospect account successfully created. |
Prospect Found | Prospect account exists in the system already based on the email, phone number, or name provided. |
PUT /prospects
Update an existing prospect. Â The prospect will be looked up by name, email and phone number(s).
PUTÂ https://api.club-os.com/prospects?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
Variable | Type | Description |
---|---|---|
clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
The following fields must be included in the body of the HTTP request as a valid JSON string.
Property | Type | Required | Default | Description |
---|---|---|---|---|
userId | Integer | Y | The Club OS userId of the propspect. | |
firstName | String | N | Prospect first name. | |
lastName | String | N | Prospect last name. | |
String | N | Prospect email address. | ||
homePhone | String | N | Prospect home phone number. | |
workPhone | String | N | Prospect work phone number. | |
mobilePhone | String | N | Prospect mobile phone number. | |
notes | String | N | Notes about the prospect. | |
guestPassStart | Date (M-d-YYYY) | N | The new start date of the prospect's guest pass. | |
guestPassEnd | Date (M-d-YYYY) | N | The new end date of the prospect's guest pass. | |
smsOptOut | Boolean | N | false | If true, the prospect will be opted out of text messages. |
emailOptOut | Boolean | N | false | If true, the prospect will be opted out of email. |
Response Messages
One of the following messages will be returned when the request succeeds.
Message | Description |
Notes have been added. | Notes were successfully added to the prospect's account. |
Prospect Not Found | Prospect account was not found based on name, email, and phone number lookup. |