Skip to main content
A modification changes one layer of a template. Send a list of them in the modifications field of a request. Modifications explains how layer names map to fields and shows examples for text, images, tables, and charts.

A change to one layer of the template for one render. A field that does not fit the layer is ignored.

name
string
required

The name of the layer to change. The match is exact and case-sensitive, and a name that no layer has is ignored.

Example:

"headline"

color
string

The text color of a text layer, for example #ff5733. Other layers ignore it.

Example:

"#FF0000"

src
string

The URL of the image for an image layer. It must be a public PNG, JPEG, WebP, or SVG file.

Example:

"https://example.com/image.jpg"

text
string

The text of a text layer, the body of an alert layer, or the signer name of a signature layer.

Example:

"Hello World"

barcode
string

The value of a barcode layer.

Example:

"1234567890"

qrcode
string

The content of a QR code layer.

Example:

"https://example.com"

visible
boolean

Show or hide the layer. It works on every layer type.

Example:

true

star
number

The rating of a star layer. A value of 0 is ignored.

Example:

5

rows
object
columns
(string | object)[]

The columns of a table layer, as a column name or as a { key, header, align, width } object

Example:
title
string

The heading of an alert layer, or the job title of a signature layer

Example:

"Payment terms"

date
string

The date of a signature layer

Example:

"2026-01-31"