Skip to main content
PATCH
/
v1
/
api
/
email
/
workspace-mailbox
Update workspace mailbox
curl --request PATCH \
  --url https://api.hq.zone/v1/api/email/workspace-mailbox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localpart": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json

PATCH the workspace outbound mailbox: change its localpart (the address all agents send from). The localpart edit renames tenants.outbound_mailbox_localpart AND the system endpoint's localpart in one transaction.

The workspace mailbox is fire-and-notify ONLY: it never auto-replies. A reply to it always files to the Review queue + notifies the initiator, so reply_policy is fixed to never_reply and is NOT configurable here (an address that answers mail is a custom inbox, created via create_endpoint). The only knob is the address.

​
localpart
string | null

Response

Workspace mailbox localpart updated