Email

Update mailbox

Update a mailbox's display name, webhook URL, or forward-to email address by its full email address. Set to null to disable/clear.

patch/api/emails/{address}

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/emails/{address}
  • Auth: HTTP bearer

Path parameters

addressstring required

Full email address (URL-encoded)

Request body

namestring nullable

Display name for the mailbox. Set to null to clear.

webhook_urlstring nullable

HTTPS URL for inbound email webhook, or null to clear

forward_tostring nullable

Email address to forward inbound emails to, or null to clear

drop_spamboolean

Drop (don't store or webhook) inbound messages flagged as spam

tone_notesstring nullable

Voice hints agents read before drafting from this mailbox (tone, signature, phrasing dos and don'ts). Set to null to clear.

Response

Mailbox updated

idstring
addressstring
slugstring
domainstring
namestring nullable
webhook_urlstring nullable
forward_tostring nullable
tone_notesstring nullable
signing_secretstring

HMAC secret for verifying inbound webhook payloads

Changes

No recorded changes to this operation across all 2 revisions of this API.