Commands

The commands endpoint is designed to manipulate visitor data easily. Add tags, update fields, and more with a single request.

get
Run Command

https://app.bentonow.com/api/v1/fetch/commands
Request
Response
Request
Headers
Basic Auth
required
string
publishable_key:secret_key
Query Parameters
site_uuid
required
string
Your site's unique identifier.
command
required
object
{ "command": "add_tag", "email": "[email protected]", "query": ""}
Response
200: OK
Returns the visitor with their updated values.
{
"data": {
"id": "236",
"type": "visitors",
"attributes": {
"uuid": "0f566d05f47a59bff25f147df3a6233d",
"email": "[email protected]",
"fields": {},
"cached_tag_ids": []
}
}
}

To run different commands, change the structure of the query.

// Tag Subscriber
{ "command": "add_tag", "email": "[email protected]", "query": "example" }
// Remove Tag
{ "command": "remove_tag", "email": "[email protected]", "query": "example" }
// Add Field
{ "command": "add_field", "email": "[email protected]", "query": {"key": "test", "value": "test" }
// Remove Field
{ "command": "remove_field", "email": "[email protected]", "query": "example" }
// Subscribe
{ "command": "add_tag", "email": "[email protected]" }
// Unsubscribe
{ "command": "add_tag", "email": "[email protected]" }