Skip to navigation
StorefrontBlogComments

Create Comment

View as Markdown

Submits a comment. Whether it shows straight away depends on the blog’s comment setting, reported in data.status. Returns 400 when the name or comment is too long, 422 when comments are closed on the article or the comment breaks a rule, and 429 past 5 comments per shopper or 200 per channel in 15 minutes. Comments can’t be edited or removed through the API; the merchant moderates them in the Papertracc app.

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.

Path parameters

handlestringRequired
The record's handle.

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.
namestringRequired<=100 characters
Name to show with the comment.
emailstringRequiredformat: "email"<=255 characters
Not shown publicly.
bodystringRequired<=2000 characters
Plain text, up to 2,000 characters. Markup is stripped.

Response

Successfully submitted comment
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

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