API Reference

Explore every REST endpoint available today—each resource includes payload schemas, sample requests, and SDK snippets so you can ship quickly.

Ship integrations faster by starting with the resource you need. Each guide captures request parameters, notes on authentication, and ready-to-run examples across Bash, JavaScript, Python, PHP, .NET, Go, Rust, and Elixir where available.

API resources

Pick a resource below to browse its endpoints. We will keep this catalog in sync as new surfaces ship.

Broadcasts

Launch large-scale campaigns, fetch historical sends, and manage approval-ready payloads by API.

POST /v1/batch/broadcasts
GET /v1/fetch/broadcasts
Open reference →

Stats

Stats delivers a clear-cut suite of API requests, providing up-to-the-minute subscriber figures, including active and unsubscribed counts. Plus, you can segment this data for even deeper insights.

GET /v1/stats/site
GET /v1/stats/segment
GET /v1/stats/report
Open reference →

Subscribers

On this page, we’ll dive into managing your subscribers. When you are a new customer with an existing list you might use the import subscribers endpoint.

POST /v1/batch/subscribers
GET /v1/fetch/search
GET /v1/fetch/subscribers
POST /v1/fetch/subscribers
POST /v1/fetch/commands
Open reference →

Fields

Fields are unique data points you collect about subscribers, essential for personalized communication. They range from basic info like first names to complex details like total purchases, preferred currency, interests, or app behavior. Field names remain consistent, but values vary, crafting rich individual profiles.

GET /v1/fetch/fields
POST /v1/fetch/fields
Open reference →

Tags

Tags are essential for mapping a subscriber's journey, from purchases to onboarding. They enable precise user segmentation, detailed queries, and laser-focused marketing.

GET /v1/fetch/tags
POST /v1/fetch/tags
Open reference →

Utility

Experimental APIs crafted for niche use cases like blacklist monitoring, validation, moderation, and geolocation.

GET /v1/experimental/blacklist.json
POST /v1/experimental/validation
POST /v1/experimental/jesses_ruleset
POST /v1/experimental/content_moderation
POST /v1/experimental/gender
GET /v1/experimental/geolocation
Open reference →

Emails

Emails efficiently handle one-off messages like welcome emails, password resets, and crucial transactions. Requests are prioritized and processed within 30 seconds.

POST /v1/batch/emails
Open reference →

Events

Events are Bento's secret weapon. These tiny data points offer sharp insights and trigger advanced automations the moment they arrive.

POST /v1/batch/events
Open reference →

Resource directory

Prefer a quick list? Every published API document appears here automatically as the collection grows.

  • Broadcasts Launch large-scale campaigns, fetch historical sends, and manage approval-ready payloads by API.
  • Stats Stats delivers a clear-cut suite of API requests, providing up-to-the-minute subscriber figures, including active and unsubscribed counts. Plus, you can segment this data for even deeper insights.
  • Subscribers On this page, we’ll dive into managing your subscribers. When you are a new customer with an existing list you might use the import subscribers endpoint.
  • Fields Fields are unique data points you collect about subscribers, essential for personalized communication. They range from basic info like first names to complex details like total purchases, preferred currency, interests, or app behavior. Field names remain consistent, but values vary, crafting rich individual profiles.
  • Tags Tags are essential for mapping a subscriber's journey, from purchases to onboarding. They enable precise user segmentation, detailed queries, and laser-focused marketing.
  • Utility Experimental APIs crafted for niche use cases like blacklist monitoring, validation, moderation, and geolocation.
  • Emails Emails efficiently handle one-off messages like welcome emails, password resets, and crucial transactions. Requests are prioritized and processed within 30 seconds.
  • Events Events are Bento's secret weapon. These tiny data points offer sharp insights and trigger advanced automations the moment they arrive.