ReferralCandy Connector Setup Guide

[#1]

This article describes how to set up the ReferralCandy connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Signup Advocate	✓	✓
Invite Advocate	✓	✓
Register a Purchase	✗	✓
Update Status of Referred Purchase	✗	✓
Unsubscribe an Advocate	✓	✓
Resubscribe an Advocate	✓	✓

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

• API Access ID
  Your API access ID can be found in the "API Tokens" section of your profile page at https://my.referralcandy.com/settings.
• API Secret Key
  Your API secret key can be found in the "API Tokens" section of your profile pageat https://my.referralcandy.com/settings.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Signup Advocate

Parameters

Parameter	Description
Email Address	Advocate's email address. For information on this endpoint, see: https://www.referralcandy.com/api#signup.
First Name	Advocate's first name.
Last Name	Advocate's last name.

Action - Invite Advocate

Parameters

Parameter	Description
Email Address	Email address to send the invite to. For information on this endpoint, see: https://www.referralcandy.com/api#invite.

Action - Register a Purchase

Parameters

Parameter	Description
Email Address	Customer's email address. For information on this endpoint, see: https://www.referralcandy.com/api#purchase.
First Name	Customer's first name.
Last Name	Customer's last name
Customer's Language	Customer's preferred language. Defaults to campaign's default language if it is not set or not available to the campaign. Possible values: en, fr, de, es, it, ja, nl, ru, zh-CN, zh-HK, zh-TW, da, no, sv, pt-BR.
Discount Code	Discount code used in the order.
Accepts Marketing	Whether the customer-opted in to marketing. Possible values: true or false. Defaults to true.
Order Timestamp	Unix timestamp of order. If not provided, current Unix timestamp will be used.
Browser IP	IP address of customer when making the purchase.
User Agent	User agent string of the customer's web browser.
Invoice Amount	Total invoice amount for this purchase.
Currency Code	ISO 4217 currency code used in order invoice (for example: USD, GBP, INR).
External Reference ID	An ID that can be used to track this purchase externally.

Action - Update Status of Referred Purchase

Parameters

Parameter	Description
Customer Email	Email address of customer who made the referred purchase. For information on this endpoint, see: https://www.referralcandy.com/api#referral.
Notify Referring Customer	Whether to notify customer who referred customer specified above that the referral has been disregarded. Potential values: true or false. Defaults to true.
Returned Purchase	Whether the customer has returned his/her purchase. Potential values: true or false. If set to true, the referral will be disregarded and rewards will not be paid out.

Action - Unsubscribe an Advocate

Parameters

Parameter	Description
Email Address	Contact's email address. For more information on this endpoint, see: https://www.referralcandy.com/api#unsubscribed.

Action - Resubscribe an Advocate

Parameters

Parameter	Description
Email Address	Contact's email address. For more information on this endpoint, see: https://www.referralcandy.com/api#unsubscribed.