Skip to Content

Approve a model or request changes

Needs the scope reviews:write

Approve a model, or send it back to our 3D team with comments. A model that has passed our quality check waits for your approval (review.requested tells you); one that is not waiting for you answers 409 not_ready.

  • approve publishes it, exactly as approving in your CharpstAR account does. asset.approved follows once its files are live. A product with variants is approved with all of them.
  • request_changes sends it back with your comments. Each comment can carry an image, which we copy to your account.
  • From the third change request on the same model, extra revisions will likely be charged. That request is made in your CharpstAR account, where you confirm it; the API answers 409 not_ready.
  • A change to a model that is already delivered is requested the same way. It stays delivered and its links keep working while we make the change. Each one counts against your yearly change allowance (402 allowance_reached once it is used up).

Path Parameters

article*string

Your article number.

Match^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$

Header Parameters

Idempotency-Key?string

A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.

Lengthlength <= 128

Request Body

application/json
  1. body
decision*string

approve publishes the model; request_changes sends it back to our 3D team with your comments.

Value in"approve""request_changes"
comments?array<>

Required with request_changes.

Itemsitems <= 20

Response Body

OK

application/json
  1. response
articleId*string
decision*string
Value in"approve""request_changes"
status*string

Where the product is. Build your logic on this value.

Value in"received""in_production""in_review""approved""delivered""cancelled"
reviewedAt*string
Formatdate-time
Example Request
curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/review \  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "decision": "request_changes", "comments": [{ "text": "The seat is too thick", "imageUrl": "https://example.com/seat.jpg" }] }'
Example Response
{  "articleId": "CH-1001",  "decision": "approve",  "status": "approved",  "reviewedAt": "2026-10-21T14:02:00.000Z"}