Skip to main content
PATCH
/
scanner
/
api
/
v1
/
proposals
/
{proposal_id}
Review an enrichment proposal
curl --request PATCH \
  --url https://www.closient.com/scanner/api/v1/proposals/{proposal_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "ACCEPTED"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "field_name": "<string>",
  "current_value": "<string>",
  "proposed_value": "<string>",
  "confidence": "<string>",
  "reasoning": "<string>",
  "source": "<string>",
  "status": "PENDING",
  "created": "2023-11-07T05:31:56Z",
  "metadata": {},
  "reviewed_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
proposal_id
string
required

Unique identifier of the enrichment proposal.

Body

application/json

Request body for accepting or rejecting an enrichment proposal.

​
status
enum<string>
required

Reviewer's decision on the pending proposal. ACCEPTED queues the proposed value to be applied by the /captures/{id}/apply endpoint; REJECTED discards it. Only ACCEPTED and REJECTED are valid here — PENDING (the initial state) cannot be set via this endpoint.

Available options:
ACCEPTED,
REJECTED

Response

200 - application/json

OK

AI-generated enrichment proposal for a product field.

​
id
string<uuid>
required

Unique proposal identifier (UUID).

​
field_name
string
required

Product field targeted by this proposal. One of: name, description, brand_name, category, ingredients, ai_summary, images.

Maximum string length: 50
​
current_value
string
required

Current value of the field on the linked product (may be empty).

​
proposed_value
string
required

AI-suggested replacement value for the field.

​
confidence
string
required

Model confidence score from 0.00 to 1.00 (two decimal places).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
reasoning
string
required

Free-form explanation of why this change was proposed.

​
source
string
required

Identifier of the system that generated this proposal — for example bedrock_claude (vision extraction), hunter_io / apollo_io (contact discovery), local_database (GTIN lookup). Free-form string; not enumerated on the model.

Maximum string length: 100
​
status
enum<string>
required

Review state of the proposal. Newly-generated proposals start PENDING; the review endpoint transitions them to ACCEPTED or REJECTED. Only ACCEPTED proposals are applied to the linked product by the apply endpoint.

Available options:
PENDING,
ACCEPTED,
REJECTED
​
created
string<date-time>
required

Timestamp when the proposal was generated.

​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
reviewed_at
string<date-time> | null

Timestamp when the proposal was reviewed.