Referrals

Create a referral campaign

post/v1/referrals

Request

  • Base URL: https://api.proof.com
  • URL: https://api.proof.com/v1/referrals
  • Auth: API key in header ApiKey

Request body

namestring required

Name of the new campaign

cover_paymentboolean

Will the organization pay for these referred transactions? This will result in single use links. Default: false

organization_idstring

ID of organization to create the campaign for, only needed when creating for a child organization

redirect_urlstring

URL that customers will be sent to from the referral. This can be set to an Easylink URL. Default: retail URL

use_brandingboolean

Will the referred transactions display the orgs branding? Default: false

Example request

{
  "name": "A New Campaign"
}

Response

Success

referral_campaign_idstring

ID of the created campaign

linkstring

For campaigns that don't cover payment, this will be the referral link that you share with signers. For campaigns that cover payment, this will be null. You will be required to generate single use links.

Changes

No recorded changes to this operation across all 1 revision of this API.