Skip to navigation
StorefrontContact

Send Message

View as Markdown

Sends a contact-form message to the merchant. It is saved in Papertracc and emailed to the workspace’s support address.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired
shopper-tokenstringOptional
Send it when the shopper is signed in.
client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
namestringRequired<=100 characters
Sender's name.
emailstringRequiredformat: "email"<=255 characters
Address the merchant should reply to.
messagestringRequired<=5000 characters
Plain text. Markup is removed.
phonestringOptional<=30 characters
subjectstringOptional<=150 characters

Response

Successfully sent message
statusboolean

Always true on success.

messagestring

Human-readable outcome.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error