documentEmailTemplates

Requires permission settings:documents:read.

Every outbound document email template that can be previewed, read straight off the registry so the settings list cannot drift from what sends.

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 DocumentEmailTemplates {
  documentEmailTemplates {
    type
    bodyTokens
    subjectTokens
    templateVersion
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentEmailTemplates {\n  documentEmailTemplates {\n    type\n    bodyTokens\n    subjectTokens\n    templateVersion\n  }\n}"
}
EOF

Response:

{
  "data": {
    "documentEmailTemplates": [
      {
        "type": "string",
        "bodyTokens": [
          "string"
        ],
        "subjectTokens": [
          "string"
        ],
        "templateVersion": 0
      }
    ]
  }
}

documentEmailTemplates: [DocumentEmailTemplateInfo!]!

Type

DocumentEmailTemplateInfo object

One previewable email template.