Update Email Settings

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V81 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp"
  }
}

Close
PUT /email_settings

Updates the server's email alert settings. Every field is optional; an omitted field is not changed. A setting that has no stored value yet is created.

Omit password to keep the stored password. An empty password, or one made only of * characters, also keeps it. Changing host or username from the stored value needs a new password in the same request, so a stored password is never sent to a different server or account.

Sending any of host, from_address, username or password sets a custom SMTP server. After the merge with the stored values, all four must be non-empty, so the first custom SMTP save needs all four.

Authorization

Same as GET /email_settings: internal API clients only; COMPANY or SERVER users on a ZWS-integrated server, SERVER users only otherwise.

Headers

  • Authorization string

    e.g. Bearer {access_token}

application/json

Body Required

  • host string

    the SMTP host name or IP address, optionally prefixed with ssl:// or tls://; no port

  • from_address string(email)

    the sender address of alert email

  • username string

    the SMTP user name

  • password string(password)

    the SMTP password; omit, or send only * characters, to keep the stored one

  • subject string

    the subject of an alert whose form sets none; non-empty

  • footer2 string

    the second footer of alert email; may be empty

Responses

  • 200 application/json

    OK - the settings were saved. The body is the updated settings, in the same shape as GET.

    Hide response attributes Show response attributes object
    • custom boolean Required

      true when the server has its own SMTP settings; false when alerts use the server default

    • host string | null Required

      the SMTP host; null when not set

    • from_address string | null Required

      the sender address of alert email; null when not set

    • username string | null Required

      the SMTP user name; null when not set

    • password_set boolean Required

      true when a non-empty SMTP password is stored

    • subject string Required

      the subject of an alert whose form sets none

    • footer2 string Required

      the second footer of alert email

  • 400

    Bad Request - the body is not a JSON object, a field has the wrong type, subject, host, from_address or username is empty or spans more than one line, host is not a host name or IP address, from_address is not a valid email address, or the SMTP credentials would be left incomplete.

  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).

PUT /email_settings
curl \
 --request PUT 'https://api.iformbuilder.com/exzact/api/v81/[servername]/email_settings' \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer {access_token}" \
 --data '{
  "host": "smtp.example.com",
  "from_address": "alerts@example.com",
  "username": "mailer",
  "password": "{smtp_password}",
  "subject": "Record received"
}'
Request example
{
  "host": "smtp.example.com",
  "from_address": "alerts@example.com",
  "username": "mailer",
  "password": "{smtp_password}",
  "subject": "Record received"
}
Response examples (200)
{
  "custom": true,
  "host": "smtp.example.com",
  "from_address": "alerts@example.com",
  "username": "mailer",
  "password_set": true,
  "subject": "Record received",
  "footer": "",
  "footer2": ""
}