Update PDF Template

PUT 
/api/pdf-templates/:id

Updates the content of a PDF template and snapshots the previous content as a new version.

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Personal Access Token (sent as a Bearer token) with the settings scope (write access).

Fields:

• content (required): the template markup string.
• updated_at (optional): the template's last-known updated_at timestamp. When supplied it enables optimistic-lock checking, so an edit made by someone else since that timestamp is rejected with a 409 instead of being silently overwritten. Re-send without updated_at to overwrite deliberately.

preview_destinations lists the destination countries a preview can be rendered against, each as a code and a label. Pass one of those codes as destination_country when previewing to see how country-conditional sections render.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

409

Conflict

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.