Sign in

New Endpoint

This is your first endpoint! Edit this page to start documenting your API.

post/

Headers

Authorizationstring

Optionally include an authorization header to ensure only valid users are accessing your endpoint. Currently, Bearer and Basic are supported types of authorization.

Request body

Recipientstring

The email address or phone number of the recipient.

RecipientSha256string

The SHA256 encoded string of the recipient, lowercased before hashing. Required if Recipient is not submitted.

WkPurposestring required

the purpose for this signal (cart abandonment, category abandonment, low stock, etc.)

WkChannelstring required

the recommended channel (email, text, etc.)

WkUserTypestring required

the recommended target (customer, prospect, all)

WkCartReplenishUrlstring

the url to drive user back to their cart (if applicable)

WkCouponCodestring

coupon code to serve (if applicable)

WkCouponPurposestring

coupon code purpose (ie - "Get 20% off") (if applicable)

Response

Successful response

Changes