ClubReady Api

CreateProspectRequestV2

The following routes are available for this service:
POST	/v2/{ApiKey}/club/{StoreId}/prospect	(obsolete) Create a Prospect

**CreateProspectRequestV2** 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
Address	query	string	No	Address
City	query	string	No	City
State	query	string	No
Zip	query	string	No
Phone	body	string	No
WorkPhone	body	string	No
DateOfBirth	body	DateTime?	No
CellPhone	body	string	No
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
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
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**CreateProspectRequestV2Dto** 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

**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 .xml suffix or ?format=xml

HTTP + XML

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: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateProspectRequestV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</StoreId>
  <AddPackageId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</AddPackageId>
  <Address xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Address>
  <CellPhone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</CellPhone>
  <City xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</City>
  <Coupon xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Coupon>
  <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</DateOfBirth>
  <Email xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Email>
  <EmailTemplateId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</EmailTemplateId>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</FirstName>
  <Gender xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Gender>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</LastName>
  <Note xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Note>
  <Phone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Phone>
  <ProspectTypeId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ProspectTypeId>
  <ReferralTypeId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ReferralTypeId>
  <SendEmail xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</SendEmail>
  <State xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</State>
  <WorkPhone xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</WorkPhone>
  <Zip xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Zip>
  <XForwardedFor>String</XForwardedFor>
</CreateProspectRequestV2>