Partner Campaign Object

Example

{
  "uuid": "partner_campaign_8aa3dbae7428",
  "partner_program_uuid": "partner_program_83eyduw91",
  "publication_uuid": "pub_1b1ae61e0c60",
  "partner_profile_uuid": "partner_0a8a45c403f8",
  "status": "active",
  "referral_link": "https://sparklp.co/p/be9dd131e6",
  "cpa": 2.5,
  "max_payout": 1000.0,
  "campaign_type": "partner_program",
  "thankyou_page_url": null,
  "accepted_terms_at": "2022-11-23T15:04:36.143Z",
  "name": "Pour Over's partner program",
  "referral_pending_period": 7,
  "remaining_budget": 12000,
  "partner_program_geo_restrictions": {
    "allow_worldwide_referrals": false,
    "allowed_countries": ["GB", "CA"],
    "blocked_countries": []
  }
}
Property
Type
Description

uuid

string

the unique ID of the partner campaign

partner_program_uuid

string

the partner program's UUID

publication_uuid

string

the publication's UUID

partner_profile_uuid

string

the partner profile's UUID

status

string

the status of the campaign

referral_link

string

the unique partner link for this campaign

cpa

float

how much this partner program pays per confirmed subscriber

max_payout

float

the max amount a partner can earn per month

campaign_type

string

the type of partner campaign

thankyou_page_url

string

the URL people are redirected to when they click on a magic link

referral_pending_period

integer

how many days subscribers have to stayed subscribed before they are confirmed.

remaining_budget

integer

Remaining budget. This figure includes an estimate of existing pending referrals. Therefore this is the highest number SparkLoop thinks is left.

partner_program_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)

Last updated