Creating referrals

You can create referral codes for your campaign by importing them into Talon.One or building a rule with an effect consisting of creating referral codes when conditions are met.

You can also create referral codes programmatically.

Creating a referral code

You can create referrals as an effect in your rules.

Learn more about it in our Developer Docs.

Importing referral codes

You can import referrals from any marketing tool to use them in Talon.One.

1. Click Referrals on the left-side menu of your campaign.

2. In the top-right corner of the page, click Import Referrals.

3. Click Upload a CSV file.

4. Select a CSV file of referral codes from your computer. Ensure the file does not contain any duplicate records.

   tip

   • To see the required structure of the CSV file, click Download a sample file.
   • To upload codes with custom attributes, see Importing codes with custom attributes.

5. Click Import Referrals.

To import more data, click Import Referrals.

important

When you import a CSV file with referrals, a customer profile is not automatically created for each advocateprofileintegrationid column value. Use the Update customer profile endpoint or the Update multiple customer profiles endpoint to create the customer profiles.

note

If no limit is set for an imported referral, the default is single-use.

Importing coupons with custom attributes

important

Before you begin, we recommend you:

• Familiarize yourself with the JSON syntax and data types.
• Ensure you know each attribute's API name, type, and value.
• Ensure that location attribute data is managed by a technical user.

To import coupons with custom attributes:

1. In your CSV file, add a column called attributes.

2. Insert a JSON object listing the key-value pairs in the attributes column.

   The pattern is: {"api_name_1": my_integer_value, "api_name_2": "my_string_value", ...}.

   Troubleshooting

   If you use a text editor to edit your CSV file, you may encounter Import Error: Read CSV error parse error on line 2 when you upload the file. To solve it, duplicate all double-quotes.

   The pattern is: "{""api_name_1"": my_integer_value, ""api_name_2"": ""my_string_value"", ...}".

The format of the attribute value depends on the attribute type, as shown in the following table:

Attribute type	Attribute value format
String	"value"
Number	1
Boolean	true or false
Time	"2022-03-15T00:00:00Z"
Location	"{\"name\":\"geofence_name\",\"format\":\"geojson-base64\",\"object\":\"geofence_data\"}"
List of strings	["value1", "value2", "value3"]
List of numbers	[1, 2, 3]
List of dates	["2022-02-15T00:00:00+02:00", "2022-10-15T00:00:00+02:00", "2022-03-16T00:00:00+02:00"]
List of locations	["{\"name\":\"geofence_name1\",\"format\":\"geojson-base64\",\"object\":\"geofence_data1\"}", "{\"name\":\"geofence_name2\",\"format\":\"geojson-base64\",\"object\":\"geofence_data2\"}", "{\"name\":\"geofence_name3\",\"format\":\"geojson-base64\",\"object\":\"geofence_data3\"}"]

Example

Imagine we want to import a coupon that has two custom attributes:

• A string attribute called type.
• A boolean attribute called added_customer_benefits.

The content of the attributes column in our CSV file must be: {"type": "special", "added_customer_benefits": true}.

Creating a referral code programmatically

To create codes programmatically, use the Import referrals via CSV file endpoint. It does the same thing as the import feature inside the Campaign Manager.

Related pages

• Creating campaign budgets
• Creating a referral campaign
• Creating a referral code as an effect