/referrals

POST /referrals

Add a referral to the system. Referrals will only be added if they are not already in the system. We match based on email or phone number; if no email is provided and the phone number is invalid, we will reject the record and not add the user.

The memberEmail must be attached to a member within a club in which you are authorized.

POST https://api.club-os.com/referrals

Request Body

The following fields must be included in the body of the HTTP request as a valid JSON string.

Property	Sub-Properties	Type	Required	Default	Description
memberEmail		String	C		The email of the member who submitted the referrals. Required if memberUserId is not provided.
memberUserId		Integer	C		The Club OS userId of the member who submitted the referrals. Required if the memberEmail is not provided.
clubLocationId		Integer	Y		The referrals that are added will be created at this club location. The member must also exist at this club location in order for the referral to be added.
salespersonId		Integer	N		The Club OS unique id for the salesperson who collected the referrals. Referrals will be assigned to this salesperson for follow-up.
skipResponseEmails		Boolean	N	false	When set to true, Club OS system and campaign emails will NOT be sent to the referrals or referring members.
referrals					A list of one or more referrals, each having the below properties.
	firstName	String	Y		Referral first name.
	lastName	String	Y		Referral last name.
	email	String	C		Referral email address. Email or 1 valid phone number is required.
	gender	String	N	M	'M' for male, 'F' for female.
	homePhone	String	C		Referral home phone number. Email or 1 valid phone number is required.
	workPhone	String	C		Referral work phone number. Email or 1 valid phone number is required.
	mobilePhone	String	C		Referral mobile phone number. Email or 1 valid phone number is required.
	source	String	N		The marketing source of the Referral, i.e. tv ad, mailer, internet, etc.
	relationship	String	N		Free form text that describes the relationship of the referral to the member, "Spouse" for example.
	notes	String	N		Free form text with any additional notes about the prospect. This will show on the referral's prospecting profile.

Response Messages

One of the following messages will be returned when the request succeeds.

Message	Description
Referrals Added	List of ReponseMessages that show the number referrals added, as well as any referrals that weren't added and the reason why
Request Failed	If the memberEmail could not be found, or there were no valid referrals submitted.