Documents

Generate a document preview

Generates a preview of an existing document or template. POST recipient and custom_fields data to populate merge fields, recipient fields and template content. The response is a hosted PDF document that expires after 10 minutes. This method is strictly for previewing and should not be used to generate the actual document.

post/v1/documents/{id}/preview

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents/{id}/preview
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the document.

Request body

namestring

Name used to fill the document merge fields.

typestring

Document type the preview is rendered as.

external_idstring

External id used to fill the document merge fields.

company_namestring

Company name used to fill the document merge fields.

company_numberstring

Company number used to fill the document merge fields.

Response

The request succeeded.

preview_urlstring required

URL of the generated preview, which expires after ten minutes.

Changes

No recorded changes to this operation across all 1 revision of this API.