Run Command
Endpoint to execute a command and change a subscriber's data.
Query Parameters
- site_uuid string required
Your site's unique identifier.
- application/json
Request Body
command object[] required
Array [command stringPossible values: [
add_tag
,add_tag_via_event
,remove_tag
,add_field
,remove_field
,subscribe
,unsubscribe
,change_email
]The command to execute.
email stringThe email address of the subscriber.
query object
The query to execute for the command.
- oneOf
- MOD1
string]
Responses
- 200
Returns the visitor with their updated values.
- application/json
- Schema
- Example (from schema)
Schema
data object
id stringThe unique identifier for the command.
type stringThe type of the data.
attributes object
uuid stringThe UUID of the visitor.
email stringThe email of the visitor.
fields objectAdditional fields related to the visitor.
cached_tag_ids string[]An array of cached tag IDs associated with the visitor.
{
"data": {
"id": "string",
"type": "string",
"attributes": {
"uuid": "string",
"email": "string",
"fields": {},
"cached_tag_ids": [
"string"
]
}
}
}
Loading...