Sign in
export

Export image

Export a design as a PNG image.

post/v3/templates/export/image

Request

  • Base URL: https://api.unlayer.com
  • URL: https://api.unlayer.com/v3/templates/export/image
  • 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[]
widthnumber
heightnumber
fullPageboolean
deviceScaleFactornumber

Response

Default Response

successboolean

Changes

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