Update Email Inbox

Beta

PATCH/v1/messaging/email-inboxes/{id}

Idempotent with Idempotency-Key header. Learn more

Edits an email inbox's from-name, status, and default agent trigger config.

Permissions requiredValues:messaging:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Email inbox ID.

include[]optional arrayenumValues:email_domainagent_config

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

statusstring

Whether the inbox routes mail.

active: inbound mail is threaded and outbound replies are allowed.
disabled: the inbox stays provisioned but does not route mail.

from_nameoptional string

Display name for the From header of outbound mail.

agent_config_idoptional string

The agent to bind to this inbox to handle incoming mail.

agent_trigger_policyoptional string

How the bound agent decides whether to run on incoming mail.

mention: runs only when the agent is @mentioned in the message.
keyword: runs when the message contains any of the trigger keywords.
always: runs on every incoming message.

agent_trigger_keywordsoptional array of string

Keywords that fire the agent when the trigger policy is keyword.

idstring

Email inbox ID.

objectstringenumValues:email_inbox

Resource type identifier.

statusstring

Whether the inbox is currently routing mail.

active: inbound mail is threaded and outbound replies are allowed.
disabled: the inbox is provisioned but drops inbound mail and does not send replies.

email_domainemail_domainExpandablenullable

The domain this inbox belongs to.

idstring

Email domain ID.

objectstringenumValues:email_domain

Resource type identifier.

domainstring

The fully-qualified domain name (e.g. support.acme.com).

statusstring

Verification status.

pending: registered and awaiting DKIM confirmation.
verified: DKIM confirmed; the domain can send and receive mail.
failed: verification could not be completed.

dkim_tokensarray of string

The DKIM CNAME tokens the customer must publish in DNS to verify the domain.

verified_atstring (date-time)nullable

When the domain's DKIM verification was confirmed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

addressstring

The full inbox address (e.g. support@acme.com).

from_namestringnullable

The display name used in the From header of outbound mail.

agent_configagent_definitionExpandablenullable

The agent that handles mail for this inbox, when one is bound.

null when no agent is bound.

idstring

Agent definition ID.

objectstringenumValues:agent_definition

Resource type identifier.

definition_typestringenumValues:systemcustom

Whether the agent is provided by Augno or created in this account.

system: provided by Augno; cannot be edited or deleted.
custom: created by a user in this account.

category_codestring

Category grouping for the agent (e.g. order_processing), used to organize agents in the UI.

trigger_typestringenumValues:scheduledmanualevent

How runs of this agent are initiated.

scheduled: runs on a cron schedule (see config.trigger_config.cron_schedule).
event: runs in response to platform events (see config.trigger_config.event_filters).
manual: runs only when explicitly invoked.
chat: runs in response to a chat message; the run is linked to a conversation and posts its reply back into it.

namestring

Human-readable name of the agent.

slugstring

URL-friendly identifier for the agent.

descriptionstringnullable

Description of what the agent does.

editabilitystringenumValues:editableread_only

Whether the current user can edit this agent definition.

Always read_only for system definitions.

statusstringenumValues:activeinactive

Whether this agent is enabled for the current account.

Activation is per-account: a system agent shared across accounts can be active for one account and inactive for another. An inactive agent does not run.

rolerolenullable

Role defining the permissions the agent operates with.

Always returned as null in this endpoint.

configagent_definition_confignullable

Agent-level configuration controlling LLM behavior and trigger settings.

Always returned as null in this endpoint.

toolslistnullable

Tools attached to this agent.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

agent_trigger_policystringnullable

When the bound agent runs on incoming mail.

mention: only when the agent is @mentioned, matched against its trigger keywords.
keyword: when the mail contains any of the configured trigger keywords.
always: on every incoming message.

agent_trigger_keywordsarray of string

Keywords that fire the agent when agent_trigger_policy is keyword.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Email Inbox

Update Email Inbox

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailInbox = await client.messaging.emailInboxes.update('eminb_018e88072d1320808dc9bbb02', {
  status: 'active',
});

console.log(emailInbox.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailInbox = await client.messaging.emailInboxes.update('eminb_018e88072d1320808dc9bbb02', {
  status: 'active',
});

console.log(emailInbox.id);

200 example

{
  "id": "eminb_018e88072d1320808dc9bbb02",
  "object": "email_inbox",
  "status": "active",
  "email_domain": {
    "id": "emdom_018e88072d1320808dc9aaa01",
    "object": "email_domain",
    "domain": "",
    "status": "",
    "dkim_tokens": [],
    "verified_at": null,
    "created_at": "0001-01-01T00:00:00Z",
    "updated_at": "0001-01-01T00:00:00Z"
  },
  "address": "support@acme.com",
  "from_name": "Acme Support",
  "agent_config": {
    "id": "agdf_01b9ef28feb99e6954201aca63",
    "object": "agent_definition",
    "definition_type": "",
    "category_code": "",
    "trigger_type": "",
    "name": "",
    "slug": "",
    "description": null,
    "editability": "",
    "status": "",
    "role": null,
    "config": null,
    "tools": null,
    "created_at": "0001-01-01T00:00:00Z",
    "updated_at": "0001-01-01T00:00:00Z"
  },
  "agent_trigger_policy": "always",
  "agent_trigger_keywords": [],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "eminb_018e88072d1320808dc9bbb02",
  "object": "email_inbox",
  "status": "active",
  "email_domain": {
    "id": "emdom_018e88072d1320808dc9aaa01",
    "object": "email_domain",
    "domain": "",
    "status": "",
    "dkim_tokens": [],
    "verified_at": null,
    "created_at": "0001-01-01T00:00:00Z",
    "updated_at": "0001-01-01T00:00:00Z"
  },
  "address": "support@acme.com",
  "from_name": "Acme Support",
  "agent_config": {
    "id": "agdf_01b9ef28feb99e6954201aca63",
    "object": "agent_definition",
    "definition_type": "",
    "category_code": "",
    "trigger_type": "",
    "name": "",
    "slug": "",
    "description": null,
    "editability": "",
    "status": "",
    "role": null,
    "config": null,
    "tools": null,
    "created_at": "0001-01-01T00:00:00Z",
    "updated_at": "0001-01-01T00:00:00Z"
  },
  "agent_trigger_policy": "always",
  "agent_trigger_keywords": [],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Email Inbox

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses