elements

Preview Element

An element drawn alone for one product, as the editor previews a design (decision 249): the server's SVG and what it read, for an element edited outside any template — its definition shown alone, or the element as the editor edits it, a document of its own.

post/companies/{company_id}/elements/preview

Request

  • Base URL
    https://app.zalster.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idstring uuid required

Company id

Query parameters

themestring nullable

none, scheduled (the default: the company's theme now) or a theme's id

atstring date-time nullable

draw as at this moment, with a time zone; now when left out

Request body

definitionobject nullable
documentobject nullable
formatstring
product_idstring uuid nullable
lookstring nullable
variantstring

Response

Successful Response

product_idstring uuid required
external_idstring required
formatstring required
svgstring required
warningsobject[] required
boundobject required
visibilityobject required
subject_boxesobject
picturesobject
overridesobject
conditionsobject
partsobject
picture_findingsobject[]
touchupsobject
codesobject
tablesobject
layoutstring nullable
explainobject

Changes

No recorded changes to this operation across all 1 revision of this API.