previewPdfTemplate

Requires an authenticated session.

Generate a preview PDF with sample data to preview template styles

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PreviewPdfTemplate {
  previewPdfTemplate
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PreviewPdfTemplate {\n  previewPdfTemplate\n}"
}
EOF

Response:

{
  "data": {
    "previewPdfTemplate": "string"
  }
}

previewPdfTemplate(
  documentType: String = "quote"
  template: String = "professional"
): String!

Arguments

previewPdfTemplate.documentType ● String scalar

The kind of document to preview.

previewPdfTemplate.template ● String scalar

The template markup to preview. Omit to preview the saved one.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.