Partner Program Object
Example
{
"uuid": "partner_program_45e5187ede44",
"publication": {
"uuid": "pub_810f4c8c08cd",
"name": "The Pour Over",
"logo" : "https://dash.sparkloop.app/rails/active_storage/representations/stamp.jpeg",
"description": "The day's biggest news paired with foundational Biblical principles. Join over 250,000 delighted subscribers!",
"url": "https://www.thepourover.org/",
"send_frequency": "1-2x per month",
"language": "English",
"categories": ["religion", "politics", "lifestyle"]
},
"status": "active",
"terms": null,
"resources_url": null,
"redirect_url": "https://www.thepourover.org/",
"thankyou_page_url": "https://www.thepourover.org/thank-you",
"cpa":2.0,
"referral_pending_duration": 10,
"geo_restrictions": {
"allow_worldwide_referrals": false,
"allowed_countries": ["GB", "CA"],
"blocked_countries": [],
"allowed_regions": []
},
"ideal_subscriber": "They should have an active interest in reading the Bible",
"expected_earning_per_referral": "$3",
"screening_strictness": "not_enough_data",
"expected_referral_confirmation_rate": 75,
"requires_approval": true,
"pilot_phase": true,
"created_at": "2022-11-23T15:04:36.143Z"
}
uuid
string
the unique ID of the partner program
publication
object
the partner program's publication. The object includes the publication's UUID, name, description, URL, send_frequency, language and categories
status
string
the status of the partner program
terms
string
custom terms and conditions of the publication
resources_url
string
the URL of the publication's resources like brand assets, testimonials, etc
redirect_url
string
the URL people are redirected to when they click on the partner link
thankyou_page_url
string
the URL people are redirected to when they click on a magic link
cpa
float
how much this partner program pays per confirmed subscriber
referral_pending_duration
integer
how many days subscribers have to stayed subscribed before they are confirmed.
geo_restrictions
object
the geo-restrictions applied to this partner program. The object includes:
allow_worldwide_referrals (boolean)
allowed_countries (array) -> which countries are allowed (Alpha-2 ISOCODE)
blocked_countries (array) -> which countries are blocked (Alpha-2 ISOCODE)
allowed_regions (array) -> allowed regions (states) in the US (Alpha-2 ISOCODE) (available only if the allowed country is the US)
screening_strictnesss
string
how strict is the screening of this partner program returns exceptionally_strict/strict/fair/very_fair when there is enough data otherwise returns not_enough_data
expected_referral_confirmation_rate
integer
the confirmation rate a good-fit partner should expect as a % (0-100)
expected_earning_per_referral
string
the amount of earnings expected per referral
ideal_subscriber
string
what type of subscribers this partner program is looking for
requires_approval
boolean
If the partner program requires approval
Note: Only available in single partner program API request
pilot_phase
boolean
if the partner program has pilot phase
created_at
timestamp
the date the partner program was created
Last updated
Was this helpful?