SparkLoop
  • API v2
    • Endpoints
      • Subscribers
        • Events
      • Referral Campaigns
        • Campaign Memberships
        • Subscribers
      • Partner Profile
        • Recommendations
        • Payouts
      • Publications
      • Upscribe
        • Recommendations
      • Partner Programs
      • Partner Network
        • Publications
        • Partner Programs
      • Webhooks
    • Schemas
      • Partner Profile Object
      • Partner Program Object
      • Publication Object
      • Subscriber Object
      • Campaign Object
      • Upscribe Object
      • Recommendation Object
    • Guides
      • How to use Upscribe via API
  • API v1
    • Campaigns
    • Subscribers
    • Events
    • Webhooks
  • Webhooks
  • Changelog
Powered by GitBook
On this page
  • Get all Upscribes
  • Get an Upscribe
  • Update Upscribe
  • Subscribe to recommendations

Was this helpful?

  1. API v2
  2. Endpoints

Upscribe

Get all Upscribes

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

Returns all Upscribes

{
  "upscribes": [
    <Upscribe Object>,
    <Upscribe Object>,
    <Upscribe Object>
  ]
}

Get an Upscribe

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

Returns a single upscribe by UUID

Path Parameters

Name
Type
Description

identifier*

string

Upscribe's UUID

{
  "upscribe": <Upscribe Object>
}
{
    "error": "Upscribe upscribe_4bc10562d97 not found."
}

Update Upscribe

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

Updates an Upscribe record

Path Parameters

Name
Type
Description

identifier*

string

Upscribe's UUID

Body parameters

Name
Type
Description

auto_pilot

boolean

Enable/disable Upscribe auto-pilot feature.

{
  "upscribe": <Upscribe Object>
}

Subscribe to recommendations

POST https://api.sparkloop.app/v2/upscribes/:identifier/subscribe

Path Parameters

Name
Type
Description

identifier*

string

Upscribe's UUID

Request Body

Name
Type
Description

subscriber*

string

The subscriber's UUID

recommendations*

string

A string of comma separated recommendations' ref_codes. ie: "a724e922a3,a338cbf66a,ed149464cb"

{
  "response": "ok"
}
{ "error" => "Parameters are missing." }
{ "error" => "Subscriber param is missing or empty." }
{ "error" => "Recommendations param is missing or empty." }
PreviousPublicationsNextRecommendations

Last updated 1 month ago

Was this helpful?