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>
}

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_email*

string

The subscriber's email address

country_code*

string

Subscriber's ISO 3166-1 Alpha2 country code. Eg: US, CA, IT

recommendations*

string

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

utm_source

string

Optional. This is used as a filter in the Advanced reports.

utm_campaign

string

Optional. This is used as a filter in the Advanced reports.

{
  "response": "ok"
}
PreviousPublicationsNextRecommendations

Last updated

Was this helpful?