Client Book

Save a design for the client

Changed on

Two ways in: draft_id promotes a draft made by /v3/compute/solve into the client's design (fast); source_design_id alone copies an existing design of the organization without recomputing. With both, the draft is saved and source_design_id is recorded as the piece it personalizes. The source design is never modified.

post/v3/client-book/client/{id}/design

Request

Path parameters

idinteger required

Request body

draft_idinteger nullable
source_design_idinteger nullable
store_idinteger nullable

The store where it was made (Analytics). Defaults to the only store assigned to the caller in Settings › Team; none if they work in several or none.

namestring nullable

Defaults to the source (or draft) name.

display_namestring nullable

The name shown to the client (Showroom, piece details, share page), up to 80 characters; without the key a copy keeps its source's, empty removes it.

descriptionstring nullable
engravingobject nullable

Inside engraving of a ring: {text, font, size} (font: script, italic, roman, serif, sans or typewriter; size: cap height in mm, 0.6–3). Null or an empty text removes it; without the key a copy keeps its source's.

Response

The client's design

Changes