updateDocumentTemplateConfig

Requires permission settings:documents:update.

Create or update the tenant document template config (style + branding + footer/terms + column visibility). Admin only.

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 UpdateDocumentTemplateConfig($input: UpdateDocumentTemplateConfigInput!) {
  updateDocumentTemplateConfig(input: $input) {
    id
    companyName
    accentColor
    companyAddress
    documentType
    footerText
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateDocumentTemplateConfig($input: UpdateDocumentTemplateConfigInput!) {\n  updateDocumentTemplateConfig(input: $input) {\n    id\n    companyName\n    accentColor\n    companyAddress\n    documentType\n    footerText\n  }\n}",
  "variables": {
    "input": {
      "documentType": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "documentType": "string"
  }
}

Response:

{
  "data": {
    "updateDocumentTemplateConfig": {
      "id": "id",
      "companyName": "string",
      "accentColor": "string",
      "companyAddress": "string",
      "documentType": "string",
      "footerText": "string"
    }
  }
}

updateDocumentTemplateConfig(
  input: UpdateDocumentTemplateConfigInput!
): DocumentTemplateConfig!

Arguments

updateDocumentTemplateConfig.input ● UpdateDocumentTemplateConfigInput! non-null input

The fields of the document template config to change.

Type

DocumentTemplateConfig object

The organization's setup of one document template.