testEmailConfig

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

Sends a test email through the organization's configuration to the address given, from the company's own sender, and reports whether it worked. 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 TestEmailConfig($input: TestEmailConfigInput!) {
  testEmailConfig(input: $input) {
    message
    success
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation TestEmailConfig($input: TestEmailConfigInput!) {\n  testEmailConfig(input: $input) {\n    message\n    success\n  }\n}",
  "variables": {
    "input": {
      "testEmail": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "testEmail": "string"
  }
}

Response:

{
  "data": {
    "testEmailConfig": {
      "message": "string",
      "success": true
    }
  }
}

testEmailConfig(
  input: TestEmailConfigInput!
): TestEmailResult!

Arguments

testEmailConfig.input ● TestEmailConfigInput! non-null input

The address to send the test to and an optional subject and message.

Type

TestEmailResult object

The result of a test email.