updateDocumentEmailCopy

Requires permission settings:documents:update.

Create or update the tenant's wording override for one document email type (subject + body, {{token}} placeholders allowed). Empty string clears a field back to the registry default. 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 UpdateDocumentEmailCopy($input: UpdateDocumentEmailCopyInput!) {
  updateDocumentEmailCopy(input: $input) {
    id
    body
    emailType
    subject
    updatedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateDocumentEmailCopy($input: UpdateDocumentEmailCopyInput!) {\n  updateDocumentEmailCopy(input: $input) {\n    id\n    body\n    emailType\n    subject\n    updatedAt\n  }\n}",
  "variables": {
    "input": {
      "emailType": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "emailType": "string"
  }
}

Response:

{
  "data": {
    "updateDocumentEmailCopy": {
      "id": "id",
      "body": "string",
      "emailType": "string",
      "subject": "string",
      "updatedAt": "2025-01-15T00:00:00Z"
    }
  }
}

updateDocumentEmailCopy(
  input: UpdateDocumentEmailCopyInput!
): DocumentEmailCopy!

Arguments

updateDocumentEmailCopy.input ● UpdateDocumentEmailCopyInput! non-null input

The fields of the document email copy to change.

Type

DocumentEmailCopy object

The organization's own wording for one type of outbound document email: the subject line and one body paragraph, merged over the default template.