export

Export PDF

Export a design as a PDF document.

post/v3/templates/export/pdf

Request

  • Base URL: https://api.unlayer.com
  • URL: https://api.unlayer.com/v3/templates/export/pdf
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

projectIdstring

The project ID (required for PAT auth, auto-resolved for API key auth)

Request body

designobject required

Unlayer design JSON

displayMode'email' | 'web' | 'popup' | 'document'
editorVersionstring
mergeTagsobject
mergeTagsSchemaobject
designTagsobject
designTagsConfigobject
safeHtmlboolean
languagestring
languagesstring[]
pageSize'Letter' | 'Legal' | 'Tabloid' | 'Ledger' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6'

Response

Default Response

successboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.