For the complete documentation index, see llms.txt. This page is also available as Markdown.

Recommendation

A newsletter recommended to your reader. Returned by the Recommendations methods.

Field
Type
Description

uuid

string

Unique identifier of the recommendation. Pass it back in subscribe.

type

string

paid or free. Paid recommendations earn you money for every confirmed referral.

name

string

Name of the recommended newsletter.

logo

string

URL of the newsletter's logo.

description

string

Description of the recommended newsletter.

recommendable

boolean

Only present when fetching an individual recommendation. true while the recommendation can still be subscribed to. When false, don't display it — subscriptions to it will be discarded.

Example

{
  "uuid": "partner_campaign_23ac0811bfff",
  "type": "paid",
  "name": "Create&Sell",
  "logo": "https://dash.sparkloop.app/rails/active_storage/representations/.../logo.png",
  "description": "Weekly, in-depth email marketing advice for creators."
}