Subscribers

This end point returns a list of your subscribers (subscribed and unsubscribed). Search subscribers by email address by providing an email query parameter.

get
Get Subscriber(s)

https://app.bentonow.com/api/v1/fetch/subscribers
Fetch one (or many) visitors with email addresses in your account.
Request
Response
Request
Headers
Basic Auth
required
string
publishable_key:secret_key
Query Parameters
uuid
optional
string
This will return the subscriber who has this identifier. It's rare you'll use this.
page
optional
string
The page of subscribers you wish to fetch.
site_uuid
required
string
Your site's unique identifier.
email
optional
string
This will return a subscriber if it exists in your account.
Response
200: OK
Returns a list of visitors.
{
"data": {
"id": "236",
"type": "visitors",
"attributes": {
"uuid": "0f566d05f47a59bff25f147df3a6233d",
"email": "[email protected]",
"fields": {},
"cached_tag_ids": []
}
}
}

post
Create Subscriber

https://app.bentonow.com/api/v1/fetch/subscribers
Creates a subscriber in your account and queues them for indexing.
Request
Response
Request
Headers
Basic Auth
required
string
publishable_key:secret_key
Query Parameters
site_uuid
required
string
Your site's unique identifier.
Body Parameters
subscriber
required
object
{ "email": "[email protected]" }
Response
201: Created
Returns the created visitor.
{
"data": {
"id": "236",
"type": "visitors",
"attributes": {
"uuid": "0f566d05f47a59bff25f147df3a6233d",
"email": "[email protected]",
"fields": {},
"cached_tag_ids": []
}
}
}