saveDocumentTemplateRevision

Requires permission documents:template:update.

Save an edit as the template's next revision. It is not published.

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

mutation SaveDocumentTemplateRevision($input: SaveDocumentTemplateRevisionInput!) {
  saveDocumentTemplateRevision(input: $input) {
    id
    createdAt
    createdBy
    dataContractVersion
    revision
    source
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SaveDocumentTemplateRevision($input: SaveDocumentTemplateRevisionInput!) {\n  saveDocumentTemplateRevision(input: $input) {\n    id\n    createdAt\n    createdBy\n    dataContractVersion\n    revision\n    source\n  }\n}",
  "variables": {
    "input": {
      "source": "string",
      "templateId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "source": "string",
    "templateId": "id"
  }
}

Response:

{
  "data": {
    "saveDocumentTemplateRevision": {
      "id": "id",
      "createdAt": "2025-01-15T00:00:00Z",
      "createdBy": "id",
      "dataContractVersion": "string",
      "revision": 0,
      "source": "string"
    }
  }
}

saveDocumentTemplateRevision(
  input: SaveDocumentTemplateRevisionInput!
): DocumentTemplateRevision!

Arguments

saveDocumentTemplateRevision.input ● SaveDocumentTemplateRevisionInput! non-null input

The template and its edited source.

Type

DocumentTemplateRevision object

One saved version of a document template's Liquid source.