ClubReady Api

CreateProspectRequest

The following routes are available for this service:
POST	/users/prospect	Create a Prospect

**CreateProspectRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	Yes	ClubReady Club ID (StoreID internally)
FirstName	query	string	Yes	First Name
LastName	query	string	Yes	Last Name
Email	query	string	Yes	Email Address
Gender	query	string	No	Gender (Format:'M'\|'F')
Address	query	string	No	Address
City	query	string	No	City
State	query	string	No
Zip	query	string	No
Phone	query	string	No	Home phone
WorkPhone	query	string	No	Work phone
DateOfBirth	query	date	No	Date of Birth (Format:YYYY-MM-DD)
CellPhone	query	string	No	Cell phone
AddPackageId	query	integer	No	Specify a Package to apply to the new prospect
ProspectTypeId	query	integer	No	Specify a specific Prospect Type for the new prospect
ReferralTypeId	query	integer	No	Specify a specific Referral Type for the new prospect
SendEmail	query	boolean	Yes	Send a Welcome email to the new prospect (Format:true\|false)
EmailTemplateId	query	integer	No	Only used if SendEmail = True
Coupon	query	string	No
Note	query	string	No	Add an internal note for the new prospect
ExternalId	query	string	No	Unique ID for the user from your system. We store internally as ExternalUserId
ReferredBy	query	integer	No	User ID of existing user who referred them.
AssignToId	query	integer	No	ClubReady UserId of staff to assign new member to.
AssignToMethod	query	integer	No	Who 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.
Username	query	string	No	Username needs to be between 4 and 255 characters
EmergencyContactName	query	string	No	Emergency contact name
EmergencyContactPhone	query	string	No	Emergency contact phone number
EmergencyContactType	query	string	No	Emergency contact relationship
EmailOptOut	query	boolean	No	Set a prospect's email opt out status (Format:true\|false)
NonPromotionalSmsOptedIn	query	boolean	No	Set a prospect's NonPromotionalSmsOptedIn status (Format:true\|false)
PromotionalSmsOptedIn	query	boolean	No	Set a prospect's NonPromotionalSmsOptedIn status (Format:true\|false)
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**CreateProspectRequestDto** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
LastName	form	string	No
Address	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Email	form	string	No
Gender	form	string	No
AddPackageId	form	int?	No
ProspectTypeId	form	int?	No
ReferralTypeId	form	int?	No
SendEmail	form	bool	No
Phone	form	string	No
WorkPhone	form	string	No
DateOfBirth	form	DateTime?	No
CellPhone	form	string	No
Coupon	form	string	No
Note	form	string	No
EmailTemplateId	form	int?	No
ExternalId	form	string	No
ReferredBy	form	int?	No
AssignToId	form	int?	No
AssignToMethod	form	int	No
ContactedHow	form	int?	No
Username	form	string	No
EmergencyContactName	form	string	No
EmergencyContactPhone	form	string	No
EmergencyContactType	form	string	No
EmailOptOut	form	bool	No
NonPromotionalSmsOptedIn	form	bool?	No
PromotionalSmsOptedIn	form	bool?	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	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 /users/prospect HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	XForwardedFor: String,
	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,
	ExternalId: String,
	ReferredBy: 0,
	AssignToId: 0,
	AssignToMethod: 0,
	Username: String,
	EmergencyContactName: String,
	EmergencyContactPhone: String,
	EmergencyContactType: String,
	EmailOptOut: False,
	NonPromotionalSmsOptedIn: False,
	PromotionalSmsOptedIn: False,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ContactedHow: 0,
	ChainId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}