ClubReady Api

<back to all web services

CreateProspectRequestV2

The following routes are available for this service:
POST/v2/{ApiKey}/club/{StoreId}/prospect(obsolete) Create a Prospect
CreateProspectRequestV2 Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesClubReady Club ID (StoreID internally)
FirstNamequerystringYesFirst Name
LastNamequerystringYesLast Name
EmailquerystringYesEmail Address
GenderquerystringNoGender
AddressquerystringNoAddress
CityquerystringNoCity
StatequerystringNo
ZipquerystringNo
PhonebodystringNo
WorkPhonebodystringNo
DateOfBirthbodyDateTime?No
CellPhonebodystringNo
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
EmailTemplateIdqueryintegerNoOnly used if SendEmail = True
CouponquerystringNo
NotequerystringNoAdd an internal note for the new prospect
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
CreateProspectRequestV2Dto 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
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /v2/{ApiKey}/club/{StoreId}/prospect HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
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-01,
	CellPhone: String,
	AddPackageId: 0,
	ProspectTypeId: 0,
	ReferralTypeId: 0,
	SendEmail: False,
	EmailTemplateId: 0,
	Coupon: String,
	Note: String,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}