HomeGuidesRecipesAPI Endpoint Reference
Log In
API Endpoint Reference

Create a referral campaign

post
https://api.proof.com/v1/referrals
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name of the new campaign

boolean

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

string
length ≤ 5000

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

string
length ≤ 5000

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

boolean

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

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago