Recommendations

Get All Upscribe Recommendations

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

Returns all recommendations for an Upscribe, including paused ones. Recommendations are ordered in descending order by created_at, meaning the first page shows the latest recommendations.

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe UUID

Query Parameters

Name	Type	Description
page	integer	Results page to return. Default is 1
per_page	integer	How many results to return per page. Default is 50

200

{
  "recommendations": [
    <Recommendation Object>,
    <Recommendation Object>,
    <Recommendation Object>,
  ],
  "meta": {
    "per_page": 50,
    "page": 2,
    "total_pages": 3,
    "total_recommendations": 62
  }
}

404: Not Found

{ "error": "Upscribe upscribe_38yhewu92 not found." }

400: Bad Request When Upscribe is not active

{ "error": "Upscribe upscribe_9uewihsi9 is not active." }

Generate recommendations

POST https://api.sparkloop.app/v2/upscribes/:upscribe_uuid/recommendations

Path Parameters

Name	Type	Description
:upscribe_uuid*	String	Upscribe UUID

Request Body

Name	Type	Description
country_code	String	Subscriber's ISO3166 Alpha2 country code. Optional but VERY important. Without it, we can't generate the correct recommendations.

200

{
  "recommendations": [
    <Recommendation Object>,
    <Recommendation Object>,
    <Recommendation Object>,
  ]
}

Edit Recommendation

PUT https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

Request Body

Name	Type	Description
reason*	String	This is what will be displayed in the recommendation widget.

200

{
  "recommendation": <Recommendation Object>
}

Pin Recommendation

PUT https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid/pin

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

200 Returns upscribe recommendation

{
  "recommendation": <Recommendation Object>
}

Unpin Recommendation

PUT https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid/unpin

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

200 Returns upscribe recommendation

{
  "recommendation": <Recommendation Object>
}

Pause Recommendation

PUT https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid/pause

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

200 Returns upscribe recommendation

{
  "recommendation": <Recommendation Object>
}

Unpause Recommendation

PUT https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid/unpause

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

200 Returns upscribe recommendation

{
  "recommendation": <Recommendation Object>
}

Delete Recommendation

DELETE https://api.sparkloop.app/v2/upscribe/:upscribe_uuid/recommendations/:uuid

Path Parameters

Name	Type	Description
upscribe_uuid*	String	Upscribe ID
uuid*	String	Recommendation ID

200