Skip to content

Update Inbox Mailbox Settings

PATCH
/inbox/mailboxes/{mailbox}/settings

Change one mailbox’s inbox settings. PARTIAL: omitted fields are left alone.

auto_respond: true LETS THE AI ANSWER REAL PEOPLE from this mailbox, unattended, so the operation is classified external (inbox:run) - the same call already made for the LinkedIn account configuration. 404 if the mailbox was never connected to the inbox.

Authorizations

Parameters

Path Parameters

mailbox
required

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

string

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

Query Parameters

provider
required

How the mailbox is connected. REQUIRED and not inferred: the same address can be connected either way, and guessing would act on the wrong transport. Closed to a Literal so an unknown value is a 422 naming both, rather than a ValueError raised inside the handler.

string
Allowed values: google_mailbox smtp

How the mailbox is connected. REQUIRED and not inferred: the same address can be connected either way, and guessing would act on the wrong transport. Closed to a Literal so an unknown value is a 422 naming both, rather than a ValueError raised inside the handler.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial update of one mailbox’s inbox settings. Mirrors ai_inbox.schemas.emails.MailboxSettingRequest: omit a field to leave it alone.

object
auto_respond
Any of:
boolean
last_unread_limit
Any of:
integer
>= 1 <= 100

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string