Subscribers
Manage your subscribers. When you are a new customer with an existing list you might use the import subscribers endpoint. Find and Search subscribers with convenient look up methods.
Available Endpoints
Method | Endpoint | Name |
---|---|---|
POST | /batch/subscribers | Import Subscribers |
GET | /fetch/search | Search Subscribers |
GET | /fetch/subscribers | Find Subscriber |
POST | /fetch/subscribers | Create Subscriber |
POST | /fetch/commands | Run Command |
The Subscriber Model
The Subscriber model contains all the identify information about your subscribers, such as their email address, first name, last name, and tags. You can add other key
/ value
fields to hold other information about the subscriber, such as notes or other important details.
Properties
- Name
email
- Type
- string
- Description
The Email Address for the subscriber.
Import Subscribers
This endpoint emulates our background processes for imports, serving as the go-to method for subscriber additions and updates. When you send your data to Bento, it's processed through our import queues. Although updates are typically swift, they can take up to 5 minutes to reflect. This endpoint is ideal for both bulk and single subscriber updates.
Required Attributes
- Name
email
- Type
- string
- Description
The Email Address for the subscriber.
Optional Attributes
- Name
first_name
- Type
- string
- Description
The first name for the subscriber
- Name
last_name
- Type
- string
- Description
The last name for the subscriber
- Name
tags
- Type
- string
- Description
Comma seperated list of tags, if a tag doesn't exist it is created.
- Name
remove_tags
- Type
- string
- Description
Comma seperated list of tags to remove from the subscriber.
- Name
some_other_field
- Type
- string
- Description
key
/value
pair for storing other fields for the subscriber.
Response
The response will contain the result count of subscribers.
Search Subscribers
This endpoint delivers a report of the most recent 100 subscribers who accessed a page resource, complete with options for date-based searching and filtering.
Required Attributes
- Name
page
- Type
- integer
- Description
Page number for the search
Optional Attributes
- Name
created_at
- Type
- object
- Description
The Creation date of the subscriber.
gt
date string - greater than date
lt
date string - less than date
- Name
updated_at
- Type
- object
- Description
The update date of the subscriber
gt
date string - greater than date
lt
date string - less than date
- Name
last_event_at
- Type
- object
- Description
The last event date of the subscriber.
gt
date string - greater than date
lt
date string - less than date
- Name
unsubscribed_at
- Type
- object
- Description
The unsubscription date of the subscriber.
gt
date string - greater than date
lt
date string - less than date
Response
Returns a report of users that match the request.
Find Subscriber
Fetch a matched subscriber in your account.
Required Attributes
- Name
email
- Type
- string
- Description
Email address to search for a match in your account
Optional Attributes
- Name
uuid
- Type
- string
- Description
This returns the subscriber with the given identifier, though it is rarely needed. Can be used in place of email address.
Response
Returns the subscriber details.
Create Subscriber
Creates a subscriber in your account and queues them for indexing.
Required Attributes
- Name
subscriber
- Type
- object
- Description
An Array of subscriber emails to create.
email
string - subscriber email address
Response
Returns the created subscribers details.
Run Command
Endpoint to execute a command and change a subscriber's data.
Required Attributes
- Name
command
- Type
- object
- Description
An Array of subscriber and details to change.
command
string -add_tag
,add_tag_via_event
,remove_tag
,add_field
,remove_field
,subscribe
,unsubscribe
,change_email
email
string - subscriber email address
query
string/object - data for the requested change
Response
Returns the updated subscriber details.