Spade Merchant Action Triggers API
Register merchant action triggers and receive triggered actions in enrichment responses
Operations 16
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/merchant-action-triggers
Check account-wide merchant trigger status · Get account-level trigger status
#
Ask an LLM
“Has my account-wide merchant trigger registration finished processing?”
“Which version of merchant triggers applies to every user in my account?”
Tell an agent
Show the status and version of my account-level merchant triggers.
Confirm the account-wide merchant trigger batch has succeeded.
PUT
/merchant-action-triggers
Replace account-wide merchant triggers · Register merchant triggers at account scope
#
Ask an LLM
“How do I flag transactions at specific merchants for all users in my Spade account?”
“Do I need a website for a merchant trigger when I don't have its address or city?”
Tell an agent
Register these merchant triggers {merchantTriggers} for my entire account.
Overwrite the account-wide merchant trigger list with {merchantTriggers}.
PATCH
/merchant-action-triggers
Add or remove individual account merchant triggers · Incremental trigger operations at account scope
#
Ask an LLM
“Can I add a few merchants to my account triggers without resending the whole list?”
“Is there a way to delete specific account-level merchant triggers by ID?”
Tell an agent
Add merchant triggers {merchantTriggers} to my account, keeping the existing ones ({operation}).
Run a {operation} on account merchant triggers with IDs {triggerIds}.
DELETE
/merchant-action-triggers
Clear all account-wide merchant triggers · Clear account-level triggers
#
Ask an LLM
“How do I remove every merchant trigger registered at the account level?”
“Does clearing account merchant triggers create a new empty version?”
Tell an agent destructive · confirm first
Remove all merchant action triggers at my account scope.
Empty out the account-level merchant trigger list.
GET
/programs/{programId}/merchant-action-triggers
Check a program's merchant trigger status · Get program-level trigger status
#
Ask an LLM
“Are the merchant triggers for one of my programs active yet?”
“What version of merchant triggers is registered for a specific program?”
Tell an agent
Show the merchant trigger status for program {programId}.
Check whether program {programId} merchant trigger registration succeeded.
PUT
/programs/{programId}/merchant-action-triggers
Replace a program's merchant triggers · Register merchant triggers at program scope
#
Ask an LLM
“How do I attach merchant actions only to transactions tagged with one program?”
“Can each program have its own list of watched merchants?”
Tell an agent
Register merchant triggers {merchantTriggers} for program {programId}.
Overwrite program {programId}'s merchant trigger list with {merchantTriggers}.
PATCH
/programs/{programId}/merchant-action-triggers
Add or remove a program's merchant triggers · Incremental trigger operations at program scope
#
Ask an LLM
“How many merchant triggers can I add to a program in one incremental request?”
“How do I drop specific merchant trigger IDs from one program?”
Tell an agent
Add merchant triggers {merchantTriggers} to program {programId} using operation {operation}.
Apply {operation} to program {programId} merchant triggers {triggerIds}.
DELETE
/programs/{programId}/merchant-action-triggers
Clear a program's merchant triggers · Clear program-level triggers
#
Ask an LLM
“How do I remove every merchant trigger from a single program?”
“Can I reset one program's merchant actions without touching account-wide ones?”
Tell an agent destructive · confirm first
Clear all merchant triggers for program {programId}.
Empty the merchant trigger list on program {programId}.
GET
/users/{userId}/merchant-action-triggers
Check a user's merchant trigger status · Get user-level trigger status
#
Ask an LLM
“Are the merchant triggers for one particular user registered successfully?”
“What merchant trigger version applies to all cards of a given user?”
Tell an agent
Show the merchant trigger status for user {userId}.
Check if user {userId}'s merchant triggers are active.
PUT
/users/{userId}/merchant-action-triggers
Replace a user's merchant triggers · Register merchant triggers at user scope
#
Ask an LLM
“How do I watch specific merchants for every card a single user holds?”
“Is there a limit of 100 merchant triggers per request for a user?”
Tell an agent
Register merchant triggers {merchantTriggers} for user {userId}.
Overwrite user {userId}'s merchant trigger list with {merchantTriggers}.
PATCH
/users/{userId}/merchant-action-triggers
Add or remove a user's merchant triggers · Incremental trigger operations at user scope
#
Ask an LLM
“Can I add one merchant trigger for a user without replacing their others?”
“How do I remove particular merchant trigger IDs for a single user?”
Tell an agent
Add merchant triggers {merchantTriggers} for user {userId} with operation {operation}.
Apply {operation} to user {userId}'s merchant triggers {triggerIds}.
DELETE
/users/{userId}/merchant-action-triggers
Clear a user's merchant triggers · Clear user-level triggers
#
Ask an LLM
“How do I wipe out all merchant triggers for one user?”
“Can I reset a single user's merchant actions to nothing?”
Tell an agent destructive · confirm first
Clear all merchant triggers for user {userId}.
Empty the merchant trigger list for user {userId}.
GET
/users/{userId}/cards/{cardId}/merchant-action-triggers
Check a card's merchant trigger status · Get card-level trigger status
#
Ask an LLM
“Are the merchant triggers on one specific card registered and active?”
“Which merchant trigger version applies to a single card only?”
Tell an agent
Show the merchant trigger status for card {cardId} of user {userId}.
Check whether card {cardId} belonging to {userId} has succeeded merchant triggers.
PUT
/users/{userId}/cards/{cardId}/merchant-action-triggers
Replace a card's merchant triggers · Register merchant triggers at card scope
#
Ask an LLM
“How do I watch certain merchants on one card but not the user's other cards?”
“Can a single card carry its own merchant trigger list?”
Tell an agent
Register merchant triggers {merchantTriggers} on card {cardId} for user {userId}.
Overwrite the merchant triggers on user {userId}'s card {cardId} with {merchantTriggers}.
PATCH
/users/{userId}/cards/{cardId}/merchant-action-triggers
Add or remove a card's merchant triggers · Incremental trigger operations at card scope
#
Ask an LLM
“Can I add a merchant trigger to just one card incrementally?”
“How do I drop specific merchant trigger IDs from a single card?”
Tell an agent
Add merchant triggers {merchantTriggers} to card {cardId} of user {userId} via {operation}.
Apply {operation} to card {cardId} (user {userId}) merchant triggers {triggerIds}.
DELETE
/users/{userId}/cards/{cardId}/merchant-action-triggers
Clear a card's merchant triggers · Clear card-level triggers
#
Ask an LLM
“How do I remove every merchant trigger from one card?”
“Can I clear a card's merchant actions while keeping the user-level ones?”
Tell an agent destructive · confirm first
Clear all merchant triggers on card {cardId} for user {userId}.
Empty the merchant trigger list for user {userId}'s card {cardId}.