Skip to main content
POST
document.template.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by document.template.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
name
string

Template name, at most 30 characters.

Required string length: 1 - 30
html
string

HTML layout with placeholders; may contain personal text.

Required string length: 1 - 262144
styles
string

CSS or SCSS styles.

Maximum string length: 65536
settings
object

Ordinary PDF printing settings; advanced rendering has a separate operation.

sampleData
object

Sample JSON data; may contain personal document text. Maximum 32 KiB.

version
enum<string>
default:draft

Which version to read or write.

Available options:
draft,
published
publishDraft
boolean
default:false

Copy the current owned draft to the published version before applying changes.

Response

The result

name
string
required

Template name, at most 30 characters.

Required string length: 1 - 30
version
enum<string>
required

Which version to read or write.

Available options:
draft,
published
format
string
required

Output format.

Allowed value: "pdf"
html
string

HTML layout with placeholders; may contain personal text.

Required string length: 1 - 262144
styles
string

CSS or SCSS styles.

Maximum string length: 65536
settings
object

Ordinary PDF printing settings; advanced rendering has a separate operation.

sampleData
object

Sample JSON data; may contain personal document text. Maximum 32 KiB.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last change time, ISO 8601.