Online
Bento
View markdown

OpenAPI-style API reference

This browser gives you one place to scan Bento endpoints, request fields, response fields, and the matching hand-written docs. It is generated from a docs-owned OpenAPI-style snapshot that follows the current MDX reference pages.

The public bentonow/api repository may be stale. This page intentionally mirrors the current docs instead of pulling that repo at build time.

Reference browser

Base URL
https://app.bentonow.com/api/v1
Snapshot
docs-snapshot-2026-06-10
Endpoints
19

This snapshot is maintained from the current Bento docs pages. The public bentonow/api repository may lag behind this reference.

Core writes

Create or update Bento data from your app.

POST/batch/events

Create events

Track user activity, update profile fields, and trigger workflows.

Endpoint docs

Request

events
arrayrequired

One to 1000 event objects.

events[].type
stringrequired

Event name.

events[].email
stringrequired

Subscriber email address.

events[].fields
object

Flat profile fields to update.

events[].details
object

Nested event-specific context.

events[].date
datetime

Optional ISO 8601 timestamp for when the event happened.

Response

results
integer

Number of events accepted.

failed
integer

Number of events rejected.

POST/batch/subscribers

Import subscribers

Bulk create or update subscribers without triggering automations.

Endpoint docs

Request

subscribers
arrayrequired

One to 1000 subscriber objects.

subscribers[].email
stringrequired

Subscriber email address.

subscribers[].first_name
string

Subscriber first name.

subscribers[].last_name
string

Subscriber last name.

subscribers[].tags
string

Comma-separated tags to add.

subscribers[].remove_tags
string

Comma-separated tags to remove.

subscribers[].utm_source
string

Attribution source for imported subscribers.

subscribers[].utm_medium
string

Attribution medium for imported subscribers.

subscribers[].utm_campaign
string

Attribution campaign for imported subscribers.

subscribers[].utm_content
string

Optional attribution content value.

subscribers[].utm_term
string

Optional attribution term value.

subscribers[].created_at
datetime

ISO 8601 timestamp to backfill the subscriber creation date.

Response

result
integer

Number of subscriber records accepted.

POST/batch/emails

Create emails

Queue transactional or one-off emails for delivery.

Endpoint docs

Request

emails
arrayrequired

One to 60 email objects.

emails[].to
stringrequired

Recipient email address.

emails[].from
stringrequired

Sender email address. Must be an author.

emails[].subject
stringrequired

Email subject.

emails[].html_body
stringrequired

HTML email body.

emails[].transactional
boolean

Send even if the user is unsubscribed.

emails[].personalizations
object

Liquid values for the email body.

Response

results
integer

Number of emails accepted.

Subscribers

Look up and modify people in Bento.

GET/fetch/searchEnterprise

Search subscribers

Search subscribers by page and filters.

Endpoint docs

Request

page
integerrequired

Result page.

tags
array|string

Preferred tag-name filter.

created_at
object

Date filter with `gt` or `lt`.

updated_at
object

Date filter with `gt` or `lt`.

Response

data
array

Matching subscriber records.

meta.page
integer

Current result page.

meta.query
object

Filters Bento applied.

GET/fetch/subscribers

Find subscriber

Fetch a subscriber by email or UUID.

Endpoint docs

Request

email
stringrequired

Subscriber email address.

uuid
string

Subscriber UUID. Can be used instead of email.

Response

data.id
string

Internal record id.

data.attributes.uuid
string

Bento subscriber UUID.

data.attributes.email
string

Subscriber email address.

data.attributes.fields
object

Custom subscriber fields.

POST/fetch/commands

Run subscriber command

Apply targeted tag, field, subscription, or email-change commands.

Endpoint docs

Request

command
arrayrequired

Command objects to run.

command[].command
stringrequired

`add_tag`, `remove_tag`, `add_field`, `remove_field`, `subscribe`, `unsubscribe`, or `change_email`.

command[].email
stringrequired

Subscriber email address.

command[].query
string|object

Command-specific value.

Response

data
object

Updated subscriber record when returned.

Definitions

Manage tag and field definitions.

GET/fetch/tags

Get tags

List tag definitions in your account.

Endpoint docs

Response

data
array

Tag records.

POST/fetch/tags

Create tag

Create one custom tag definition.

Endpoint docs

Request

name
stringrequired

Tag name.

Response

data.name
string

Created tag name.

GET/fetch/fields

Get fields

List custom field definitions.

Endpoint docs

Response

data
array

Field records.

POST/fetch/fields

Create field

Create one custom profile field.

Endpoint docs

Request

key
stringrequired

Field key.

Response

data.name
string

Created field key.

Marketing content

Read and modify campaign, sequence, workflow, and template records.

GET/fetch/broadcasts

Get broadcasts

List broadcast history and draft or scheduled broadcast metadata.

Endpoint docs

Request

page
integer

Result page.

status
string

`sent`, `draft`, `sending`, `scheduled`, `paused`, or `canceled`.

Response

data
array

Broadcast records.

POST/batch/broadcasts

Create broadcasts

Create broadcast campaigns for a segment or tag audience.

Endpoint docs

Request

broadcasts
arrayrequired

Broadcast objects to create.

broadcasts[].name
stringrequired

Campaign name.

broadcasts[].subject
stringrequired

Subject line.

broadcasts[].content
stringrequired

Email body.

Response

results
integer

Broadcasts accepted for processing.

GET/fetch/sequences

Get sequences

List sequences and attached email templates.

Endpoint docs

Response

data
array

Sequence records.

GET/fetch/workflows

Get workflows

List workflows and attached email templates. Read-only.

Endpoint docs

Response

data
array

Workflow records.

GET/fetch/emails/templates/:id

Get email template

Fetch one email template with HTML and stats.

Endpoint docs

Request

id
integerrequired

Template id.

Response

data.attributes
object

Template content and stats.

PATCH/fetch/emails/templates/:id

Update email template

Update the subject or HTML for one template.

Endpoint docs

Request

id
integerrequired

Template id.

email_template.subject
string

Updated subject.

email_template.html
string

Updated HTML.

Response

data.attributes
object

Updated template content.

Stats and validation

Read reporting data and validate risky inputs.

GET/stats/site

Get site stats

Fetch top-level site subscriber statistics.

Endpoint docs

Response

user_count
integer

Total users.

subscriber_count
integer

Active subscribers.

unsubscriber_count
integer

Unsubscribed users.

POST/experimental/validation

Validate email

Return a conservative valid or invalid result for signup forms.

Endpoint docs

Request

email
stringrequired

Email address to validate.

name
string

Optional contact name to screen.

Response

valid
boolean

Whether Bento considers the signup valid.

POST/experimental/content_moderation

Moderate content

Check small text payloads for risky content.

Endpoint docs

Request

content
stringrequired

Text to moderate.

Response

valid
boolean

Whether the content is safe.

reasons
array

Detected issues.

How this snapshot works

The snapshot lives in site/data/docs/openapi-reference.js. Hand-written endpoint pages remain the source for deeper examples, caveats, and operational notes. Use this browser for quick schema lookup, then open the endpoint docs for implementation details.

Was this page useful?

Your answer helps us find docs that need work.