Upscribe

Get all Upscribes

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

Returns all Upscribes

200

{
  "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

200

{
  "upscribe": <Upscribe Object>
}

404

Not found

{
    "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.

200

{
  "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.

200: OK

{
  "response": "ok"
}

400

Parameters missing

{ "error" => "Parameters are missing." }

Subscriber param missing

{ "error" => "Subscriber param is missing or empty." }

Recommendations param missing

{ "error" => "Recommendations param is missing or empty." }