Developer API Documentation
Search…
API v1 — Fetch Endpoint
API V1 - Batch Endpoint
API V1 (Experimental)
Commands
The commands endpoint is designed to manipulate visitor data easily. Add tags, update fields, and more with a single request. Great for tiny updates!
This endpoint is designed for single updates on a visitor. To update multiple fields consider using the
batch/subscribers` or `batch/events` endpoints.This endpoint does not trigger automations with the exception of the
add_tag_via_event command.post
https://app.bentonow.com
/api/v1/fetch/commands
Run Command
To run different commands, change the structure of the query.
1
// Tag Subscriber
2
{ "command": "add_tag", "email": "[email protected]", "query": "example" }
3
4
// Tag Subscriber via Event (Triggers Automations)
5
{ "command": "add_tag_via_event", "email": "[email protected]", "query": "example" }
6
7
// Remove Tag
8
{ "command": "remove_tag", "email": "[email protected]", "query": "example" }
9
10
// Add Field
11
{ "command": "add_field", "email": "[email protected]", "query": {"key": "test", "value": "test" }
12
13
// Remove Field
14
{ "command": "remove_field", "email": "[email protected]", "query": "example" }
15
16
// Subscribe
17
{ "command": "subscribe", "email": "[email protected]" }
18
19
// Unsubscribe
20
{ "command": "unsubscribe", "email": "[email protected]" }
21
22
// Change email
23
{ "command": "change_email", "email": "[email protected]", "query": "[email protected]" }
Copied!
Last modified 1mo ago
Copy link
Contents
post
Run Command