Partner Programs

Create partner program

POST https://api.sparkloop.app/v2/partner_programs

Request Body

Name	Type	Description
max_payout*	number	The most any one partner can earn per month. In US dollars ($).
total_budget*	number	Monthly spend cap. Set a cap on the total monthly spend across your partner programs. Once your spend cap is reached, partners will be notified and you won't be charged for any further referrals in that calendar month. In US dollars ($).
cpa*	number	The default fee you want to pay partners for each new subscriber they send you, e.g. 2.5 In US dollars ($).
redirect_url*	String	Default partner link destination. It's where people will go when they click on a partner link.
thankyou_page_url	String	Thank-you page URL. It's what we show new subscribers when they subscribe via Magic Link.
terms	String	Custom partner program conditions.
resources_url	String	Partner resources URL. If you've created any resources to help partner promote you effectively, link them here.
slug	String	Your unique custom signup page URL, e.g. if you set slug to morning-stew the custom signup page URL will be https://partnerprogram.page/morning-stew
show_in_directory	boolean	Set to true if you want to feature the partner program in SparkLoop Partner Network. Get discovered by thousands of pre-approved newsletter partners and let them join your partner program with one click.
referral_pending_duration_enabled	boolean	Set to true if you want to exclude referrals if they unsubscribe shortly after signup.
referral_pending_duration	integer	Referrals will be confirmed if they've stayed subscribed for at least this number of days.
publication_uuid*	String	UUID of a publication for which you're creating this partner program.
allow_worldwide_referrals	Boolean	Set to true if you want referrals from anywhere in the world. If set to false it is required for you to pass allowed_countries or blocked_countries
allowed_countries	Array	This field is required if allow_worldwide_referrals is set to false. Which countries are allowed (Alpha-2 ISOCODE). e.g. ["US", "CA", "GB"]
blocked_countries	Array	This field is required if allow_worldwide_referrals is set to false. Which countries are blocked (Alpha-2 ISOCODE). e.g. ["US", "CA", "GB"]

201: Created

{
  "partner_program":
    {
      "uuid": "partner_program_23374dada923",
      "name": "MyString",
      "description": "MyString",
      "terms": null,
      "resources_url": null,
      "redirect_url": "https://sparkloop.app/newsletter",
      "show_in_directory": true,
      "thankyou_page_url": null,
      "referral_pending_duration": 7,
      "referral_pending_duration_enabled": true,
      "max_payout": 500.0,
      "total_budget": 2000.0,
      "cpa": 3.0,
      "created_at": "2022-10-07T15:17:49.909Z",
      "publication_uuid": "pub_cd44a97a3fa4",
      "categories": ["tech"]
   }
}

400

Publication not found

{
    "error": "Publication pub_12345abc not found!"
}

Get partner programs

GET https://api.sparkloop.app/v2/partner_programs

Partner programs are ordered descendingly by created_at, meaning the first page shows the latest publications.

200 Used query params ?page=1&per_page=2

{
  "partner_programs": [
    {
      "uuid": "partner_program_23374dada923",
      "name": "MyString",
      "description": "MyString",
      "terms": null,
      "resources_url": null,
      "redirect_url": "https://sparkloop.app/developer-newsletter",
      "show_in_directory": true,
      "thankyou_page_url": null,
      "referral_pending_duration": 7,
      "referral_pending_duration_enabled": true,
      "max_payout": 500.0,
      "total_budget": 2000.0,
      "cpa": 3.0,
      "created_at": "2022-10-07T15:17:49.909Z",
      "publication_uuid": "pub_cd44a97a3fa4",
      "categories": ["tech"]
   },
   {
      "uuid": "partner_program_12345dada923",
      "name": "MyString",
      "description": "MyString",
      "terms": null,
      "resources_url": null,
      "redirect_url": "https://sparkloop.app/newsletter",
      "show_in_directory": true,
      "thankyou_page_url": null,
      "referral_pending_duration": 7,
      "referral_pending_duration_enabled": true,
      "max_payout": 500.0,
      "total_budget": 2000.0,
      "cpa": 3.0,
      "created_at": "2022-10-07T15:17:49.909Z",
      "publication_uuid": "pub_432217a3fa4",
      "categories": ["marketing"]
   }
  ],
  "meta": {
    "per_page": 2,
    "page": 1,
    "total_pages": 12,
    "total_partner_programs": 24
  }
}

Get a partner program

GET https://api.sparkloop.app/v2/partner_programs/:identifier

Returns a single partner program by UUID

Path Parameters

Name	Type	Description
identifier*	string	Partner program's UUID

200

{
  "partner_program":
    {
      "uuid": "partner_program_23374dada923",
      "name": "MyString",
      "description": "MyString",
      "terms": null,
      "resources_url": null,
      "redirect_url": "https://sparkloop.app/newsletter",
      "show_in_directory": true,
      "thankyou_page_url": null,
      "referral_pending_duration": 7,
      "referral_pending_duration_enabled": true,
      "max_payout": 500.0,
      "total_budget": 2000.0,
      "cpa": 3.0,
      "created_at": "2022-10-07T15:17:49.909Z",
      "publication_uuid": "pub_cd44a97a3fa4",
      "categories": ["tech"]
   }
}

404

Partner program not found

{
    "error": "Partner program partner_program_4bc10562d97 not found!"
}

Update partner program

PUT https://api.sparkloop.app/v2/partner_programs/:identifier

Path Parameters

Name	Type	Description
identifier*	string	Partner programs's UUID

Request Body

Name	Type	Description
max_payout	number	The most any one partner can earn per month. In US dollars ($).Name
total_budget	number	Monthly spend cap. Set a cap on the total monthly spend across your partner programs. Once your spend cap is reached, partners will be notified and you won't be charged for any further referrals in that calendar month. In US dollars ($).
cpa	number	The default fee you want to pay partners for each new subscriber they send you, e.g. 2.5 In US dollars ($).
redirect_url	String	Default partner link destination. It's where people will go when they click on a partner link.
slug	String	Your unique custom signup page URL, e.g. if you set slug to morning-stew the custom signup page URL will be https://partnerprogram.page/morning-stew
thankyou_page_url	String	Thank-you page URL. It's what we show new subscribers when they subscribe via Magic Link.
resources_url	String	Partner resources URL. If you've created any resources to help partner promote you effectively, link them here.
terms	String	Custom partner program conditions.
show_in_directory	boolean	Set to true if you want to feature the partner program in SparkLoop Partner Network. Get discovered by thousands of pre-approved newsletter partners and let them join your partner program with one click.
referral_pending_duration_enabled	boolean	Set to true if you want to exclude referrals if they unsubscribe shortly after signup.
referral_pending_duration	number	Referrals will be confirmed if they've stayed subscribed for at least this number of days.

200

{
  "partner_program":
    {
      "uuid": "partner_program_23374dada923",
      "name": "MyString",
      "description": "MyString",
      "terms": null,
      "resources_url": null,
      "redirect_url": "https://sparkloop.app/newsletter",
      "show_in_directory": true,
      "thankyou_page_url": null,
      "referral_pending_duration": 7,
      "referral_pending_duration_enabled": true,
      "max_payout": 500.0,
      "total_budget": 2000.0,
      "cpa": 3.0,
      "created_at": "2022-10-07T15:17:49.909Z",
      "publication_uuid": "pub_cd44a97a3fa4",
      "categories": ["tech"]
   }
}

400

404

Partner program not found

{
    "error": "Partner program partner_program_34c8e39ca4 not found!"
}