ClubReady Api

<back to all web services

UserAccountRequest

The following routes are available for this service:
PUT/users/{UserId}Update user account info
UserAccountRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
UserIdqueryintegerYes
StoreIdqueryintegerNoStoreId OR ChainId is required
ChainIdqueryintegerNoStoreId OR ChainId is required
FirstNamequerystringNo
LastNamequerystringNo
HomePhonequerystringNo
CellPhonequerystringNo
Address1querystringNo
CityquerystringNo
StatequerystringNo(Format:2 characters; Example:'MO')
ZipquerystringNo
EmailquerystringNo
GenderquerystringNoGender (Format:'M'|'F')
DateOfBirthquerydateNoDate of Birth (Format:YYYY-MM-DD)
UsernamequerystringNoUsername should be between 4 and 255 characters long
ExternalIdquerystringNoUnique ID for the user from your system. We store internally as ExternalUserId
EmergencyContactNamequerystringNoEmergency contact name
EmergencyContactPhonequerystringNoEmergency contact phone number
EmergencyContactTypequerystringNoEmergency contact relationship
ProspectTypeIdqueryintegerNoProspect Type Id
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
UserAccountRequestDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
FirstNameformstringNo
LastNameformstringNo
HomePhoneformstringNo
CellPhoneformstringNo
Address1formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
EmailformstringNo
GenderformstringNo
DateOfBirthformDateTime?No
UsernameformstringNo
ExternalIdformstringNo
EmergencyContactNameformstringNo
EmergencyContactPhoneformstringNo
EmergencyContactTypeformstringNo
ProspectTypeIdformint?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.

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

{
	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
}