Skip to navigation
StorefrontNewsletter

Subscribe

View as Markdown

Adds an email address to the workspace’s newsletter subscribers. Subscribing an address that is already on the list succeeds, and an address that had unsubscribed is subscribed again.

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
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.
emailstringRequiredformat: "email"<=255 characters
Address to subscribe.
first_namestringOptional<=50 characters
last_namestringOptional<=50 characters

Response

Successfully subscribed
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