API Reference

What partner reference is and why it can be useful

Partner Reference is a field within the top-level Partner object within the API.

It allows a partner to pass in a customer-specific value (as opposed to a Campaign Code that operates at a higher level across a group of customers).

ℹ️

Please be aware that there is a restriction on the length of the reference that can be passed, as well as it only supporting certain characters. Please refer to the API documentation for up-to-date information on any restrictions.

This field is to be made available in the CSV file that is shared with partners as part of the Data Reporting to allow partners to correlate data items back to an individual.

In addition, if partners are constructing their own EC journey link to integrate with Aro, then it is now possible for them to add the pref URL query parameter in addition to their own source code parameters so as to pass this value into our system.