ClubReady Api

<back to all web services

CreateProspectRequest

The following routes are available for this service:
POST/users/prospectCreate a Prospect
CreateProspectRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesClubReady Club ID (StoreID internally)
FirstNamequerystringYesFirst Name
LastNamequerystringYesLast Name
EmailquerystringYesEmail Address
GenderquerystringNoGender (Format:'M'|'F')
AddressquerystringNoAddress
CityquerystringNoCity
StatequerystringNo
ZipquerystringNo
PhonequerystringNoHome phone
WorkPhonequerystringNoWork phone
DateOfBirthquerydateNoDate of Birth (Format:YYYY-MM-DD)
CellPhonequerystringNoCell phone
AddPackageIdqueryintegerNoSpecify a Package to apply to the new prospect
ProspectTypeIdqueryintegerNoSpecify a specific Prospect Type for the new prospect
ReferralTypeIdqueryintegerNoSpecify a specific Referral Type for the new prospect
SendEmailquerybooleanYesSend a Welcome email to the new prospect (Format:true|false)
EmailTemplateIdqueryintegerNoOnly used if SendEmail = True
CouponquerystringNo
NotequerystringNoAdd an internal note for the new prospect
ExternalIdquerystringNoUnique ID for the user from your system. We store internally as ExternalUserId
ReferredByqueryintegerNoUser ID of existing user who referred them.
AssignToIdqueryintegerNoClubReady UserId of staff to assign new member to.
AssignToMethodqueryintegerNoWho should be assigned to this lead? 0 = Default lead assignments, 1 = When passing in a ReferredBy user, assign the new Lead to that referring user's Staff assignment.
UsernamequerystringNoUsername needs to be between 4 and 255 characters
EmergencyContactNamequerystringNoEmergency contact name
EmergencyContactPhonequerystringNoEmergency contact phone number
EmergencyContactTypequerystringNoEmergency contact relationship
EmailOptOutquerybooleanNoSet a prospect's email opt out status (Format:true|false)
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
CreateProspectRequestDto Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AddressformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
EmailformstringNo
GenderformstringNo
AddPackageIdformint?No
ProspectTypeIdformint?No
ReferralTypeIdformint?No
SendEmailformboolNo
PhoneformstringNo
WorkPhoneformstringNo
DateOfBirthformDateTime?No
CellPhoneformstringNo
CouponformstringNo
NoteformstringNo
EmailTemplateIdformint?No
ExternalIdformstringNo
ReferredByformint?No
AssignToIdformint?No
AssignToMethodformintNo
ContactedHowformint?No
UsernameformstringNo
EmergencyContactNameformstringNo
EmergencyContactPhoneformstringNo
EmergencyContactTypeformstringNo
EmailOptOutformboolNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/prospect HTTP/1.1 
Host: www.clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","StoreId":0,"FirstName":"String","LastName":"String","Email":"String","Gender":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","WorkPhone":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","CellPhone":"String","AddPackageId":0,"ProspectTypeId":0,"ReferralTypeId":0,"SendEmail":false,"EmailTemplateId":0,"Coupon":"String","Note":"String","ExternalId":"String","ReferredBy":0,"AssignToId":0,"AssignToMethod":0,"Username":"String","EmergencyContactName":"String","EmergencyContactPhone":"String","EmergencyContactType":"String","EmailOptOut":false,"RestrictedId":0,"RestrictedResourceType":"Store","ContactedHow":0,"ChainId":0}