Sequences

Sequences are automated email series sent to subscribers over time, such as onboarding or drip campaigns. Each sequence contains email templates sent on configured delays. Use this API to list sequences, create sequence emails, and update existing template content.

Available Endpoints

MethodEndpoint

GET

/fetch/sequences

Get Sequences

List sequences and associated email templates.

POST

/fetch/sequences/:id/emails/templates

Create Sequence Email

Create a new email template inside a sequence.

PATCH

/fetch/emails/templates/:id

Update Sequence Email

Update an existing sequence email template.

The Sequence Model

The sequence model represents an automated email series with its associated email templates and performance statistics.

Properties

Name
idstring
Description
The unique identifier for the sequence
Name
namestring
Description
The name of the sequence
Name
created_atdatetime
Description
When the sequence was created
Name
email_templatesarray
Description
Array of email templates in this sequence, each with id, subject, and stats

GET/v1/fetch/sequences

Get Sequences

Returns a list of all sequences in your account, including their associated email templates and performance statistics.

Query Parameters

Name
site_uuidstringRequired
Description
Your site's unique identifier
Name
pageinteger
Description
Page number for pagination (optional)

Response

Returns a list of sequences with their email templates and stats.

Name
dataarray
Description
Sequence records.
Name
data[].idstring
Description
Sequence identifier.
Name
data[].namestring
Description
Sequence name.
Name
data[].email_templatesarray
Description
Email templates attached to the sequence.

POST/v1/fetch/sequences/:id/emails/templates

Create Sequence Email

Creates a new email template inside a sequence.

The sequence id is the sequence prefix ID (for example, sequence_abc123).

Path Parameters

Name
idstringRequired
Description
The sequence prefix ID

Query Parameters

Name
site_uuidstringRequired
Description
Your site's unique identifier

Request Body

Name
email_template.subjectstringRequired
Description
Subject line for the new sequence email
Name
email_template.htmlstringRequired
Description
HTML body for the email
Name
email_template.delay_intervalstring
Description
Optional delay unit: minutes, hours, days, or months
Name
email_template.delay_interval_countinteger
Description
Optional delay amount (must be paired with delay_interval)
Name
email_template.inbox_snippetstring
Description
Optional preview text snippet
Name
email_template.editor_choicestring
Description
Optional editor mode

Code

curl -L -u publishableKey:secretKey \
  -X POST "https://app.bentonow.com/api/v1/fetch/sequences/sequence_abc123/emails/templates?site_uuid=ExampleID1234" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "email_template": {
      "subject": "Welcome to Bento",
      "html": "<h1>Hello {{ visitor.first_name }}</h1>",
      "delay_interval": "days",
      "delay_interval_count": 7,
      "inbox_snippet": "Start here",
      "editor_choice": "plain"
    }
  }'

Response

Returns the created email template.

Name
data.idinteger
Description
Created email template ID.
Name
data.typestring
Description
Resource type, typically email_template.
Name
data.attributes.subjectstring
Description
Subject line for the created sequence email.
Name
data.attributes.htmlstring
Description
HTML content for the created sequence email.
Name
data.attributes.statsobject|null
Description
Performance stats. New templates usually return null.

Code

{
  "data": {
    "id": 12345,
    "type": "email_template",
    "attributes": {
      "name": "Welcome to Bento",
      "subject": "Welcome to Bento",
      "html": "<h1>Hello {{ visitor.first_name }}</h1>",
      "created_at": "2026-02-15T10:30:00Z",
      "stats": null
    }
  }
}

PATCH/v1/fetch/emails/templates/:id

Update Sequence Email

Updates an existing sequence email template by template ID.

Update currently supports subject and html only. Other sequence-email fields (delay, snippet, cc/bcc, etc.) are created via the sequence create endpoint.

Path Parameters

Name
idintegerRequired
Description
Email template ID

Query Parameters

Name
site_uuidstringRequired
Description
Your site's unique identifier

Request Body

Name
email_template.subjectstring
Description
Updated subject line
Name
email_template.htmlstring
Description
Updated HTML content

Code

curl -L -u publishableKey:secretKey \
  -X PATCH "https://app.bentonow.com/api/v1/fetch/emails/templates/12345?site_uuid=ExampleID1234" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "email_template": {
      "subject": "Updated subject",
      "html": "<h1>Updated HTML</h1>"
    }
  }'

Response

Returns the updated email template.

Name
data.idinteger
Description
Updated email template ID.
Name
data.typestring
Description
Resource type, typically email_template.
Name
data.attributes.subjectstring
Description
Updated subject line.
Name
data.attributes.htmlstring
Description
Updated HTML content.