ClubReady Api

UserAccountRequest

The following routes are available for this service:
PUT	/users/{UserId}	Update user account info

**UserAccountRequest** 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
UserId	query	integer	Yes
StoreId	query	integer	No	StoreId OR ChainId is required
ChainId	query	integer	No	StoreId OR ChainId is required
FirstName	query	string	No
LastName	query	string	No
HomePhone	query	string	No
CellPhone	query	string	No
Address1	query	string	No
City	query	string	No
State	query	string	No	(Format:2 characters; Example:'MO')
Zip	query	string	No
Email	query	string	No
Gender	query	string	No	Gender (Format:'M'\|'F')
DateOfBirth	query	date	No	Date of Birth (Format:YYYY-MM-DD)
Username	query	string	No	Username should be between 4 and 255 characters long
ExternalId	query	string	No	Unique ID for the user from your system. We store internally as ExternalUserId
EmergencyContactName	query	string	No	Emergency contact name
EmergencyContactPhone	query	string	No	Emergency contact phone number
EmergencyContactType	query	string	No	Emergency contact relationship
ProspectTypeId	query	integer	No	Prospect Type Id
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**UserAccountRequestDto** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
FirstName	form	string	No
LastName	form	string	No
HomePhone	form	string	No
CellPhone	form	string	No
Address1	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Email	form	string	No
Gender	form	string	No
DateOfBirth	form	DateTime?	No
Username	form	string	No
ExternalId	form	string	No
EmergencyContactName	form	string	No
EmergencyContactPhone	form	string	No
EmergencyContactType	form	string	No
ProspectTypeId	form	int?	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ChainId	form	int?	No
ApiKey	form	string	No
StoreId	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.

PUT /users/{UserId} HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	XForwardedFor: String,
	ApiKey: String,
	UserId: 0,
	StoreId: 0,
	ChainId: 0,
	FirstName: String,
	LastName: String,
	HomePhone: String,
	CellPhone: String,
	Address1: String,
	City: String,
	State: String,
	Zip: String,
	Email: String,
	Gender: String,
	DateOfBirth: 0001-01-01,
	Username: String,
	ExternalId: String,
	EmergencyContactName: String,
	EmergencyContactPhone: String,
	EmergencyContactType: String,
	ProspectTypeId: 0,
	RestrictedId: 0,
	RestrictedResourceType: User
}