Skip to content

Submit a comment on a post

POST
/public/stores/{storeRef}/blog/posts/{postId}/comments
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/public/stores/example/blog/posts/1/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-storefront-api-key: <x-storefront-api-key>' \
--data '{ "author_name": "example", "content": "example", "author_website": "example", "parent_comment_id": 1 }'

Adds a comment to a post on behalf of the signed-in customer, whose email is recorded with it. The comment is visible at once unless the store moderates comments, in which case it waits for approval. Answers 403 when the store has turned comments off, and 401 for a guest session.

postId
required
integer

The post ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
author_name
required

Name shown with the comment, 1 to 100 characters.

string
>= 1 characters <= 100 characters
content
required

The comment text.

string
>= 1 characters
author_website

The commenter’s website, up to 255 characters.

string
<= 255 characters
parent_comment_id

ID of the comment this one replies to.

number

Example generated

{
"author_name": "example",
"content": "example",
"author_website": "example",
"parent_comment_id": 1
}
Media typeapplication/json
object
id
required

Comment ID.

number
blog_post_id
required

ID of the post the comment belongs to.

number
nullable
parent_comment_id
required

ID of the comment this one replies to, or null for a top-level comment.

number
nullable
author_name
required

Name of the commenter.

string
author_email
required

Email of the commenter.

string
author_website

Website of the commenter, or null.

string
nullable
content
required

Comment text.

string
is_approved

Whether the comment is approved and visible on the storefront.

boolean
nullable
created_at

When the comment was created, as an ISO 8601 timestamp.

string
nullable
post_title

Title of the post the comment belongs to. Present on the store-wide comment list only.

string
nullable

Example generated

{
"id": 1,
"blog_post_id": 1,
"parent_comment_id": 1,
"author_name": "example",
"author_email": "example",
"author_website": "example",
"content": "example",
"is_approved": true,
"created_at": "example",
"post_title": "example"
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}