Fields

Fields are unique data points you collect about a subscriber, forming the backbone of personalized data in Bento. These can range from simple information like their first name to more complex details such as total purchases, preferred currency, or even interests and application behavior patterns. Each field name remains consistent for every subscriber, while the values vary, allowing for rich individual profiles.

Available Endpoints

Method	Endpoint	Name
POST	fetch/fields	Create Fields
GET	fetch/fields	Get Fields

The Field Model

The field model is a simple named key value pair, think of it as a form field.

Properties

Name
name
Type
string
Description
The name of the Field

GET/v1/fetch/fields

Get Fields

Returns a list of fields in your account.

Request

GET

/v1/fetch/fields

curl -L -X GET 'https://app.bentonow.com/api/v1/fetch/fields?site_uuid=ExampleID1234' \
-H 'Accept: application/json' \
-H 'Authorization: Basic BASE64ENCODE(USERNAME+PASSWORD)'

Response

Returns a list of Fields in your account.

JSON Response

{
  "data": [
    {
      "id": "1234",
      "type": "visitors-fields",
      "attributes": {
        "name": "Last Name",
        "key": "last_name",
        "whitelisted": null,
      }
    }
  ]
}

POST/v1/fetch/fields

Create Field

Creates a custom field in your account.

Only a single field can be created at a time.

Required Attributes

Name
key
Type
string
Description
The name of the field to create.

Request

POST

/v1/fetch/fields

curl -L -X POST 'https://app.bentonow.com/api/v1/fetch/fields?site_uuid=ExampleID1234' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic BASE64ENCODE(USERNAME+PASSWORD)' \
--data-raw '{
  "field": {
    "key": "example"
  }
}'

Response

Returns the details of the created Field.

JSON Response

"data": [
  {
    "id": "1234",
    "type": "visitors-fields",
    "attributes": {
      "name": "Last Name",
      "key": "last_name",
      "whitelisted": null,
    }
  }
]