Email Inbox Settings
Inspect connected inboxes and update their signatures, response delay and email handling through Copilot, MCP or REST.
Ask Copilot to list the business's connected email inboxes, inspect one, or change its settings. Each inbox has its own settings, including response delay and separate human-agent and bot signatures. The same controls are available under Settings -> Channels -> Email, in the inbox table and Edit settings.
MCP tools
| Tool | Arguments | Result |
|---|---|---|
list_email_inboxes | businessId, optional includeArchived (default false) | Inbox summaries |
get_email_inbox | businessId, inboxId | Inbox summary plus settings |
update_email_inbox | businessId, inboxId, patch | Complete updated inbox |
Use the list tool to discover inbox IDs. MCP also requires the selected organizationId, as with other organization-scoped tools. Reads work for read-only callers; updates require write access. All IDs are checked against the selected organization and business.
Summaries contain id, businessId, emailAddress, type, isPrimary, isArchived and disconnectedAt. The provider type is one of gmail, microsoft, smtp_imap, octocom_mail, reamaze, gorgias, freshdesk, helpscout or zendesk. A null emailAddress means the address could not be resolved; it does not prove that the inbox is unconfigured. A null disconnectedAt means no disconnection is recorded, not a live verification of provider health.
Editable settings
| Field | Meaning |
|---|---|
agentSignature | Shared human-agent signature. Supports Markdown and {{name}}. Maps to Agent Signature in the dashboard. |
botSignature | Default bot signature, supporting Markdown. Existing conversation-level overrides still apply. |
emailResponseDelayMinutes | Nonnegative whole minutes of configured delay for this inbox. Zero means no configured delay. |
threadMergeCutoffMinutes | Positive whole minutes for the conversation merge window. |
receiveInbound | Create conversations from incoming customer emails. False allows outbound-only use. |
aiRepliesEnabled | Enable AI replies to incoming customer emails. |
spamDetectionEnabled | Enable incoming spam detection. |
allowRespondToUnknownThreads | Let the bot answer emails that appear to be replies but cannot be matched to an existing thread. Otherwise hand them to a human. |
Only fields supplied in patch change. Set either signature to null to clear it. Empty patches and unsupported fields are rejected. Enabling AI replies or spam detection also enables inbound mail, matching the dashboard. Explicitly combining either enabled control with receiveInbound: false is rejected. Turning off inbound mail alone preserves the other controls for later use.
For example, after reading the inbox, update its default bot signature and delay:
{
"organizationId": "YOUR_ORGANIZATION_ID",
"businessId": "YOUR_BUSINESS_ID",
"inboxId": "INBOX_ID_FROM_LIST",
"patch": {
"botSignature": "Best regards,\nCustomer Support",
"emailResponseDelayMinutes": 5
}
}Read the returned inbox to verify the result. Successful changes record before/after settings in configuration history, with MCP or Copilot attribution when applicable. These history entries do not provide automatic rollback.
REST API
Authenticate with X-API-Key and select the business using its businessSlug query parameter:
| Method | Path | Input |
|---|---|---|
GET | /rest/v1/email-inboxes?businessSlug=your-business | Optional includeArchived=true |
GET | /rest/v1/email-inboxes/{inboxId}?businessSlug=your-business | No body |
PATCH | /rest/v1/email-inboxes/{inboxId}?businessSlug=your-business | Settings patch directly as the JSON body |
Responses wrap the result in { "data": ... }. REST uses the same settings, validation and organization/business checks as MCP, and records changes with API attribution. Invalid input returns 400, inaccessible businesses or inboxes return 404, and updates to archived inboxes or businesses return 409. Archived inboxes can be inspected but must be restored through the dashboard before editing.
Scope
These tools manage settings of existing inboxes. Provider type, connected address, primary selection and archive state are read-only. Connecting or reconnecting providers, Gmail or Outlook OAuth, DNS/domain setup, credentials and provider-specific settings remain in the email connection workflow. Sender-name overrides and the legacy autoresponder have been removed and cannot be configured here.