Letterby Docs

Changelog

Changes to the Letterby API, newest first.

New fields and endpoints are added to /v1 without notice, so ignore fields you do not know. A change that would break existing code ships under a new version prefix.

2026-11-16

Changed

  • budgetCents and monthlyBudgetCents cannot be set below what an offer spent plus the payouts held by subscribers still in screening (budget_below_spent, monthly_budget_below_spent).

2026-11-15

Changed

  • Activating an offer through the API now needs a balance of at least one payout (insufficient_balance).
  • An offer can no longer be archived through the API. Archive it in the dashboard.
  • budgetCents cannot be set below what an offer already spent (budget_below_spent).
  • Ending an agreement that already ended returns 200 instead of an error.
  • A tracking link whose agreement is no longer active returns 410.

Added

  • iconUrl, clickIdParamName and dailyBudgetCents can be updated on an offer.
  • Offer status insufficient_funds.
  • Subscriber status screened.

2026-11-14

Added

  • Agreement status pending. When an advertiser approves partners by hand, accepting an offer returns 202 and no tracking link. agreement.accepted is sent once they approve. A declined request becomes rejected.
  • creatorPayoutCents on agreements and directory offers: what you earn per verified subscriber.

2026-09-28

First public release of the API.

On this page