Skip to content

Update a reply

PUT
/stores/{storeRef}/reviews/{reviewId}/replies/{replyId}
curl --request PUT \
--url https://apibase.ecomweb.app/api/v1/stores/example/reviews/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "content": "example", "is_visible": true }'

Changes a reply’s text or whether it is shown to shoppers. Only the fields you send change. The reply is found by replyId alone.

Required scopes: write:reviews

reviewId
required
string format: uuid

The review ID.

replyId
required
string format: uuid

The reply ID.

storeRef
required
string

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

Media typeapplication/json
object
content

Reply text.

string
is_visible

Whether the reply is shown to shoppers.

boolean

Example generated

{
"content": "example",
"is_visible": true
}
Media typeapplication/json
object
deleted_at

When the reply was deleted. Always null on replies you can read.

string
nullable
id
required

Reply ID.

string
review_id
required

ID of the review the reply answers.

string
content
required

Reply text.

string
author_id
required

ID of the user who wrote the reply.

string
author_name
required

Name shown as the reply’s author.

string
is_visible
required

Whether the reply is shown to shoppers.

boolean
created_at
required

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

string
updated_at
required

When the reply was last updated, as an ISO 8601 timestamp.

string

Example generated

{
"deleted_at": "example",
"id": "example",
"review_id": "example",
"content": "example",
"author_id": "example",
"author_name": "example",
"is_visible": true,
"created_at": "example",
"updated_at": "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"
}