Update notification settings

PUT/api/users/me/notifications

Configure account-level webhook and email notifications for the authenticated customer or manager.

This applies to all mailboxes managed by that user. It does not disable the quota warning emails sent directly to mailbox users.

Behavior:

Omitted fields keep their current value.
Boolean action fields enable or disable only that action.
Destination fields (notification_url, notification_email) may remain saved when all actions are disabled, so they can be reused later.

Authorization

api_key

X-Api-Token<token>

API token used to authenticate requests.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

notification_url?string

Webhook endpoint that receives enabled notifications as JSON POST requests.

Requirements:

Must be an absolute https:// URL.
Required when enabling email_overquota_callback or domain_create_callback, unless a valid URL is already configured.

Used for:

mailbox quota webhooks (email_overquota)
domain creation webhooks (domain_create)

email_overquota_callback?boolean

Enable or disable webhooks for mailbox quota events across all managed mailboxes.

When enabled, Qboxmail sends an email_overquota webhook when:

a mailbox crosses a warning or critical quota threshold
a mailbox returns below a recovery threshold

The webhook payload includes:

event: exceeded or back_to_normal
metric: space or messages
domain_name
payload.email_address
payload.email_code
payload.assigned_size
payload.used_size
payload.crossed, the threshold that triggered the event

domain_create_callback?boolean

Enable or disable webhooks when a managed domain is created and activated.

The webhook is sent to notification_url with action_type: domain_create and includes:

the domain name
the postmaster code
the postmaster token, when available for the customer

This action shares the same notification_url used by mailbox quota webhooks.

notification_email?string

Email address that receives account-level notification emails.

Notes:

This is the customer or manager notification recipient, not the mailbox owner.
Required when enabling email_overquota_email, unless an email address is already configured.

email_overquota_email?boolean

Enable or disable account-level email notifications for mailbox quota events across all managed mailboxes.

Emails are sent to notification_email when:

a mailbox becomes almost full
a mailbox reaches a critical threshold
a mailbox returns below a recovery threshold

Events can refer to storage space or message count. Setting this to false stops only the extra customer or manager notification; mailbox users keep receiving their built-in quota warnings.

Response Body

`application/json`

curl -X PUT "https://example.com/api/users/me/notifications" \  -H "X-Api-Token: YOUR_API_TOKEN" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "message": "Unauthorized",
  "errors": []
}

{
  "message": "Forbidden",
  "errors": []
}

{
  "message": "Not found",
  "errors": []
}

{
  "message": "Validation failed",
  "errors": [
    {
      "field": "name",
      "description": "is not valid"
    }
  ]
}

Update notification settings

Authorization

Request Body

Response Body

204

401application/json

403application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`