Agent inboxes

Update or pause an agent inbox

Change its settings, or pause/resume it with status (paused + optional pauseReason, or active). Its sponsor or an admin; only an admin changes the sponsor or disclosure. A pause for complaints or bounces can't be lifted early (409), and the one that waits for a person needs an admin. Agent keys can't change their own rules.

patch/api/v1/inboxes/{id}

Request

  • Base URL: https://supermailos.com
  • URL: https://supermailos.com/api/v1/inboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Agent inbox id (its mailbox id).

Request body

namestring
descriptionstring
sponsorUserIdstring

A person in the workspace (admins only).

sendMode'approval' | 'known' | 'open'
inboundMode'all' | 'verified' | 'allowlist'
dailySendCapinteger
newRecipientsDailyCapinteger
allowSendersstring[]
blockSendersstring[]
allowRecipientsstring[]
disclosureboolean

End its mail with a line saying an AI agent sent it, for whom (admins only).

status'active' | 'paused'

paused stops its sending; active resumes it.

pauseReasonstring

Response

Updated.

Changes

No recorded changes to this operation across all 1 revision of this API.