---
title: "Preview Element"
method: POST
path: "/companies/{company_id}/elements/preview"
tags: ["elements"]
---

# Preview Element

`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)
- URL: `https://app.zalster.com/companies/{company_id}/elements/preview`
- Auth: none declared

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.

## Path parameters

- `company_id` string, uuid, required: Company id

## Query parameters

- `theme` string, nullable: none, scheduled (the default: the company's theme now) or a theme's id
- `at` string, date-time, nullable: draw as at this moment, with a time zone; now when left out

## Request body

- ElementPreviewRequest: An element drawn alone for one product (decision 249): its definition, as the library or a template keeps it, and one of its looks — or, as the editor sends it, the element as a document of its own (one format, its body as the layers).
  - `definition` object, nullable
  - `document` object, nullable
  - `format` string
  - `product_id` string, uuid, nullable
  - `look` string, nullable
  - `variant` string

## Response `200`

Successful Response

- TemplatePreviewOut
  - `product_id` string, uuid, required
  - `external_id` string, required
  - `format` string, required
  - `svg` string, required
  - `warnings` object[], required
  - `bound` object, required
  - `visibility` object, required
  - `subject_boxes` object
  - `pictures` object
  - `overrides` object
  - `conditions` object
  - `parts` object
  - `picture_findings` object[]
  - `touchups` object
  - `codes` object
  - `tables` object
  - `layout` string, nullable
  - `explain` object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zalster/apis/zalster-feed-processor.md) - [All operations](https://skmtc.dev/zalster/apis/zalster-feed-processor/llms.txt) - [OpenAPI document](https://skmtc.dev/zalster/apis/zalster-feed-processor/revisions/d0b9dc66ad36?raw)