RHrhinoartisan
Design

Update a design

Changed on

Updates name, description, the semantic sentence and/or the full list of collections. draft_id replaces the geometry with a newer solve (the draft is consumed). Only the provided fields change.

put/v3/backoffice/design/{id}

Request

Path parameters

idinteger required

Request body

namestring
descriptionstring nullable
semanticstring nullable

The piece in one sentence; the engine writes it on compute, Merchandising can polish it.

draft_idinteger

A draft from /v3/compute/solve whose compute result replaces this design's.

collection_idsinteger[]
notesstring nullable

Internal retailer notes (max 5000), stored with the author and date. Empty or null removes them. Never sent to the Showroom.

badgestring nullable

Merchandising label over the photo: new, bestseller, essential, limited or free text (max 30). Empty or null removes it.

display_namestring nullable

The name the store's customer sees (max 80). Empty or null: the store shows name.

referencestring nullable

The store reference (SKU, max 40), unique in the organization: 409 REFERENCE_TAKEN when another design has it. Empty or null removes it.

tagsstring[]

The retailer's own words for the piece (vintage, gift, everyday…), found by the showroom search. Up to 20, 30 characters each, trimmed and deduplicated; the full list replaces the previous one.

design_typestring nullable

Piece type, a RhinoArtisan Outliner code (RING, EARRING, PENDANT, NECKLACE, BRACELET, COMPONENT). null clears it (and the subtype).

design_subtypestring nullable

Subtype, one of the type's (RING_SOLITAIRE_BASKET, ETERNITY_BAND, WEDDING_BAND_DIAMOND...). Without design_type it keeps the current type, or takes the subtype's.

Response

Design updated

Changes