Skip to main content
POST
Execute Custom Action

Authorizations

X-Zaymo-API-Key
string
header
required

Zaymo will authenticate requests using the API key you provide

Body

application/json

Custom action request with customer email and action identifier

email
string<email>
required

The email address of the customer who clicked the button

Example:

"customer@example.com"

action_id
string
required

Unique identifier for the specific action that was triggered. You can use any action_id that makes sense for your business. Example action_ids: 'claim_discount_10off', 'join_waitlist_product_123', 'change_to_quarterly', 'register_webinar_march'

Example:

"claim_discount_10off"

Response

Custom action executed successfully

success
boolean
required

Indicates if the custom action was executed successfully

Example:

true