Derive an edited colour Candidate
Derives a new pending candidate from one you read, with its display_color or
its material.finish edited. Send the candidate_sha256 you read: another
answers 409 CANDIDATE_DIGEST_MISMATCH. The source is never changed and may be
in any review state; the new candidate names it in derived_from_candidate_id
and is reviewed on its own. Its fields say which values were measured and
which edited, and staging it asserts them as the draft’s appearance.
The same edit of the same candidate answers 200 with the candidate it already
made. Send an Idempotency-Key: it is required, and a retry with the same key
and the same request answers the first response, byte for byte, with
Idempotency-Replayed: true.
Requires the digitisation.write scope.
Authentication
API key for one environment of your account. Keep server-side; never expose in browser clients.
Path parameters
Headers
Request
Edit a candidate: the digest of the candidate the editor saw, and at least one appearance field to set or a subject. The candidate is never changed; the edit is a new one.
The product the images show, as the caller names it. Every field is optional
and descriptive: it is what a reviewer reads, never what is measured. A stage of
a candidate defaults its external_ref and shade_name from it.
Response
The candidate this edit already made; a replay under the same Idempotency-Key answers with Idempotency-Replayed: true
Who made a decision: user, a person in the Platform, or api_key. It
names no person; the Platform shows who.