Qodex.ai

Create referral

GET {{integrationBaseUrl}}/iterable/referral?deployment={{talonDeployment_3rdParty}}&campaignId={{campaignId}}&advocateProfileIntegrationId=testAdvocateProfile&friendProfileIntegrationId=testFriendProfile&startDate=2022-09-30T15:35:02Z&expiryDate=2022-10-30T15:35:02Z&usageLimit=1&.firstName=john&.country=DE

Create a referral code in Talon.One. To use it in your Iterable deployment and generate the request, see the tutorial.

Request Params

KeyDatatypeRequiredDescription
deploymentstring(Required) The base URL of your deployment.
campaignIdstring(Required) The ID of the campaign in Talon.One.
advocateProfileIntegrationIdstring(Required) The integration ID of the advocate.
friendProfileIntegrationIdstringThe profile ID of the referred customer.
startDatestringThe date when the code becomes usable.
expiryDatestringThe date when the code becomes unusable.
usageLimitnumberNumber of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.
.firstNamestringOptional parameter to set the value of custom attributes. They are defined in the Campaign Manager,
see Managing attributes.

Prefix each attribute name with ..

Certain attributes can also be set to mandatory in your Application settings. If your Application uses mandatory attributes, you must use this parameter to set their value.

Full URI example: https://<url>?applicationId=5&.myAttribute1=1234&.myAttribute2=abc. | | .country | string | | Optional parameter to set the value of custom attributes. They are defined in the Campaign Manager, see Managing attributes.

Prefix each attribute name with ..

Certain attributes can also be set to mandatory in your Application settings. If your Application uses mandatory attributes, you must use this parameter to set their value.

Full URI example: https://<url>?applicationId=5&.myAttribute1=1234&.myAttribute2=abc. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring