Skip to main content

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. Click Import Referrals at the top-right corner of the page.

  3. Click Upload a CSV file.

  4. Select a CSV file of referral codes from your computer.

    tip

  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 codes with custom attributes​

Important

Before you begin, we recommend you:

To import codes 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 typeAttribute value format
String"value"
Number1
Booleantrue 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 code that has 2 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.