updateEmailSettings

Requires at least one of the permissions settings:email:update or settings:tenant:update.

Updates the email settings: SMTP host, port, user, password and encryption, the sender name and address, reply-to, and default CC and BCC for document emails. Returns the saved settings. Needs settings:email:update, or settings:tenant:update.

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 UpdateEmailSettings($input: EmailSettingsInput!) {
  updateEmailSettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateEmailSettings($input: EmailSettingsInput!) {\n  updateEmailSettings(input: $input) {\n    id\n    createdAt\n    category\n    dataType\n    description\n    enteredBy\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateEmailSettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}

updateEmailSettings(
  input: EmailSettingsInput!
): [TenantSetting!]!

Arguments

updateEmailSettings.input ● EmailSettingsInput! non-null input

The email settings to change; fields left out stay as they are.

Type

TenantSetting object

A setting of the organization.