API Reference

What campaign code is and why it can be useful

📘

Campaign codes are used for business reporting purposes

This may become useful in a case where you'd like to track which applicant's come from what source

The campaign code you provide to us in the payload for an applicant will be the same campaign code provided back for that applicant for reporting.

Primarily this is intended for tracking marketing campaigns.

For example:

A Partner begins a marketing initiative via Google Ads and want to track which applicants were sourced from Google Ads traffic vs organic traffic. The Partner would provide a campaign code in the payload for the Google Ads traffic, this is simply a key they have decided to map applicants to.

The Partner decides that this key will be "GOOGLE-ADS".

The resulting report would include records that conform to something like this:

FieldValue
email[email protected]
partner_codeFFW-TEST
campaign_codeGOOGLE-ADS
application_created_date01/06/2023
declinedN
proceededY
funded_date01/06/2023
funded_loan_amount10000
funded_apr19.2
funded_term32
partner_referenceREF123