For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set storefront visibility (no longer supported)

Deprecated: storefront visibility now follows moderation and cannot be set directly. Use POST /conversations/{id}/approve/ to publish a review or question and POST /conversations/{id}/reject/ to take it down. Private messages are never listed on the storefront.

The endpoint is kept so that older clients receive an explanation rather than 404. The body is still validated, and then every valid request is refused with 406 and conversation_100_2. Nothing is changed and no event is recorded.

Deprecated
post
/conversations/{id}/update-private-status/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idintegerRequired

The unique identifier of the conversation.

Body

The body accepted — and then always refused — by the deprecated visibility endpoint.

is_publicbooleanRequired

The requested storefront visibility. Validated, then never applied.

Responses
400

is_public is missing or is not a boolean. The body is validated before the request is refused.

application/json

Returned when the request contains invalid or missing data. Errors are grouped by the field they apply to: each key is the name of a field from the request and its value is a list of one or more messages describing what is wrong with that field. Messages that do not belong to any single field are grouped under non_field_errors.

non_field_errorsstring[]Optional

Error messages that apply to the request as a whole rather than to a specific field.

Other propertiesstring[]Optional

The list of error messages for the field named by the key.

post/conversations/{id}/update-private-status/
POST /api/v1/remote/1/conversations/{id}/update-private-status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "is_public": true
}
{
  "is_public": [
    "This field is required."
  ]
}

Last updated

Was this helpful?