deleteEmailConfig

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

Deletes the organization's email configuration. Requires permission to update email settings.

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 DeleteEmailConfig {
  deleteEmailConfig
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteEmailConfig {\n  deleteEmailConfig\n}"
}
EOF

Response:

{
  "data": {
    "deleteEmailConfig": true
  }
}

deleteEmailConfig: Boolean!

Type

Boolean scalar

The Boolean scalar type represents true or false.