Incremental trigger operations at user scope
curl --request PATCH \
--url https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"operation": "add",
"merchantTriggers": [
{
"id": "trigger-12345",
"merchantName": "Starbucks",
"action": {
"type": "REWARD",
"rewardPercent": 5,
"offerId": "offer-abc123"
},
"website": "https://www.starbucks.com",
"address": "123 Main St",
"city": "Seattle",
"region": "WA",
"country": "USA",
"postalCode": "98101",
"latitude": 47.6062,
"longitude": -122.3321,
"level": "corporation",
"customAttributes": {
"storeId": "store-789"
}
}
],
"triggerIds": [
"merchant_123",
"merchant_456"
]
}
'import requests
url = "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers"
payload = {
"operation": "add",
"merchantTriggers": [
{
"id": "trigger-12345",
"merchantName": "Starbucks",
"action": {
"type": "REWARD",
"rewardPercent": 5,
"offerId": "offer-abc123"
},
"website": "https://www.starbucks.com",
"address": "123 Main St",
"city": "Seattle",
"region": "WA",
"country": "USA",
"postalCode": "98101",
"latitude": 47.6062,
"longitude": -122.3321,
"level": "corporation",
"customAttributes": { "storeId": "store-789" }
}
],
"triggerIds": ["merchant_123", "merchant_456"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operation: 'add',
merchantTriggers: [
{
id: 'trigger-12345',
merchantName: 'Starbucks',
action: {type: 'REWARD', rewardPercent: 5, offerId: 'offer-abc123'},
website: 'https://www.starbucks.com',
address: '123 Main St',
city: 'Seattle',
region: 'WA',
country: 'USA',
postalCode: '98101',
latitude: 47.6062,
longitude: -122.3321,
level: 'corporation',
customAttributes: {storeId: 'store-789'}
}
],
triggerIds: ['merchant_123', 'merchant_456']
})
};
fetch('https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'operation' => 'add',
'merchantTriggers' => [
[
'id' => 'trigger-12345',
'merchantName' => 'Starbucks',
'action' => [
'type' => 'REWARD',
'rewardPercent' => 5,
'offerId' => 'offer-abc123'
],
'website' => 'https://www.starbucks.com',
'address' => '123 Main St',
'city' => 'Seattle',
'region' => 'WA',
'country' => 'USA',
'postalCode' => '98101',
'latitude' => 47.6062,
'longitude' => -122.3321,
'level' => 'corporation',
'customAttributes' => [
'storeId' => 'store-789'
]
]
],
'triggerIds' => [
'merchant_123',
'merchant_456'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers"
payload := strings.NewReader("{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "succeeded",
"version": 5
}{
"status": "succeeded",
"version": 1,
"merchantTriggers": [
{
"id": "merchant_123",
"action": {
"type": "REWARD",
"points": 200
}
}
],
"totalCount": 50000
}{
"invalidField": [
"This field is required."
]
}{
"details": "Incorrect authentication credentials."
}{
"details": "Internal server error."
}Merchant Action Triggers
Incremental trigger operations at user scope
Perform incremental operations on merchant action triggers at the user scope.
See the account-scope PATCH endpoint for full documentation on supported operations (add, remove).
PATCH
/
users
/
{userId}
/
merchant-action-triggers
Incremental trigger operations at user scope
curl --request PATCH \
--url https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"operation": "add",
"merchantTriggers": [
{
"id": "trigger-12345",
"merchantName": "Starbucks",
"action": {
"type": "REWARD",
"rewardPercent": 5,
"offerId": "offer-abc123"
},
"website": "https://www.starbucks.com",
"address": "123 Main St",
"city": "Seattle",
"region": "WA",
"country": "USA",
"postalCode": "98101",
"latitude": 47.6062,
"longitude": -122.3321,
"level": "corporation",
"customAttributes": {
"storeId": "store-789"
}
}
],
"triggerIds": [
"merchant_123",
"merchant_456"
]
}
'import requests
url = "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers"
payload = {
"operation": "add",
"merchantTriggers": [
{
"id": "trigger-12345",
"merchantName": "Starbucks",
"action": {
"type": "REWARD",
"rewardPercent": 5,
"offerId": "offer-abc123"
},
"website": "https://www.starbucks.com",
"address": "123 Main St",
"city": "Seattle",
"region": "WA",
"country": "USA",
"postalCode": "98101",
"latitude": 47.6062,
"longitude": -122.3321,
"level": "corporation",
"customAttributes": { "storeId": "store-789" }
}
],
"triggerIds": ["merchant_123", "merchant_456"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operation: 'add',
merchantTriggers: [
{
id: 'trigger-12345',
merchantName: 'Starbucks',
action: {type: 'REWARD', rewardPercent: 5, offerId: 'offer-abc123'},
website: 'https://www.starbucks.com',
address: '123 Main St',
city: 'Seattle',
region: 'WA',
country: 'USA',
postalCode: '98101',
latitude: 47.6062,
longitude: -122.3321,
level: 'corporation',
customAttributes: {storeId: 'store-789'}
}
],
triggerIds: ['merchant_123', 'merchant_456']
})
};
fetch('https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'operation' => 'add',
'merchantTriggers' => [
[
'id' => 'trigger-12345',
'merchantName' => 'Starbucks',
'action' => [
'type' => 'REWARD',
'rewardPercent' => 5,
'offerId' => 'offer-abc123'
],
'website' => 'https://www.starbucks.com',
'address' => '123 Main St',
'city' => 'Seattle',
'region' => 'WA',
'country' => 'USA',
'postalCode' => '98101',
'latitude' => 47.6062,
'longitude' => -122.3321,
'level' => 'corporation',
'customAttributes' => [
'storeId' => 'store-789'
]
]
],
'triggerIds' => [
'merchant_123',
'merchant_456'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers"
payload := strings.NewReader("{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/users/{userId}/merchant-action-triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operation\": \"add\",\n \"merchantTriggers\": [\n {\n \"id\": \"trigger-12345\",\n \"merchantName\": \"Starbucks\",\n \"action\": {\n \"type\": \"REWARD\",\n \"rewardPercent\": 5,\n \"offerId\": \"offer-abc123\"\n },\n \"website\": \"https://www.starbucks.com\",\n \"address\": \"123 Main St\",\n \"city\": \"Seattle\",\n \"region\": \"WA\",\n \"country\": \"USA\",\n \"postalCode\": \"98101\",\n \"latitude\": 47.6062,\n \"longitude\": -122.3321,\n \"level\": \"corporation\",\n \"customAttributes\": {\n \"storeId\": \"store-789\"\n }\n }\n ],\n \"triggerIds\": [\n \"merchant_123\",\n \"merchant_456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "succeeded",
"version": 5
}{
"status": "succeeded",
"version": 1,
"merchantTriggers": [
{
"id": "merchant_123",
"action": {
"type": "REWARD",
"points": 200
}
}
],
"totalCount": 50000
}{
"invalidField": [
"This field is required."
]
}{
"details": "Incorrect authentication credentials."
}{
"details": "Internal server error."
}Authorizations
Path Parameters
Your unique identifier for the user
Maximum string length:
512Body
application/json
Request body for incremental merchant action trigger operations.
- For
add:merchantTriggersis required.triggerIdsis optional and ignored if provided. - For
remove:triggerIdsis required and must be a non-empty list.
The operation to perform:
add: Register new merchants or update existing ones via merchant matchingremove: Remove merchants (excluded from enrichment lookups)
Available options:
add, remove Example:
"add"
List of merchant triggers to add. Required for the add operation.
If a trigger ID already exists, the old registration is replaced (upsert behavior).
Field requirements:
id,merchantName, andactionare always requiredleveldefaults tolocationif omitted- For
level: "location"(default): requires bothaddressandpostalCode, or bothlatitudeandlongitude - For
level: "corporation": requireswebsiteon its own, or bothaddressandpostalCode, or bothlatitudeandlongitude - Triggers that don't meet these requirements are rejected with a
400error
Required array length:
1 - 100000 elementsShow child attributes
Show child attributes
List of trigger IDs to remove. Required and must be non-empty for the remove operation.
Trigger IDs that are not currently active are silently ignored (idempotent).
For add operations, this field is optional and ignored if provided — you may pass null, [], or omit it entirely.
Maximum string length:
512Example:
["merchant_123", "merchant_456"]