Account and notifications
Change your name and which optional emails you get, and read and mark your in-app notifications.
These endpoints act for the signed-in person, so they need a person's OAuth sign-in, such as the AbuseZero CLI or the AbuseZero MCP server signed in with OAuth. An API key or machine client belongs to the workspace, not to a person, so it gets MEMBER_SIGN_IN_REQUIRED (403).
Your sign-in and security settings, such as your password, two-factor authentication and account email, stay in the dashboard. See REST API, MCP server and CLI coverage.
Examples on this page use a server client signed in with OAuth:
import { AbuseZero } from "abusezero/server";
const abusezero = new AbuseZero({
accessToken: process.env.ABUSEZERO_ACCESS_TOKEN!,
workspace: "95082035373438252677",
outage: "throw",
});Change your name
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
PATCH | /v1/account | operations:general | Required |
Also available as abusezero account update in the AbuseZero CLI, abusezero_update_account_name on the AbuseZero MCP server and updateAccountName() in the AbuseZero Node.js SDK.
| Field | Type | Required | Limits | Description |
|---|---|---|---|---|
name | string | Yes | 1 to 100 characters | Your name, as members and emails show it. |
await abusezero.updateAccountName("Alex Kim", "account-name-2026-11-10");Returns 200.
{ "object": "account", "name": "Alex Kim" }Email notification settings
Four groups of email can be turned on or off, as in the dashboard's Account & security → Notifications. Emails about your sign-in, your account's security and billing always arrive, and so do the emails where AbuseZero pauses or cancels something. A choice applies in every workspace you're in. Turning a group off stops only its emails: its notifications still appear.
{
"object": "email_preferences",
"members_and_invitations": true,
"imports_and_exports": true,
"integration_alerts": true,
"weekly_summary": false
}| Field | Type | Description |
|---|---|---|
members_and_invitations | boolean | An invitation accepted, declined, canceled, expired or not delivered, a new member joining, and an admin sending an invitation. |
imports_and_exports | boolean | Claim history imports from receiving the file to adding the claims, and a workspace data export that failed. |
integration_alerts | boolean | Evaluations that stopped arriving, browser script problems and a webhook endpoint that was disabled after failed deliveries. |
weekly_summary | boolean | Each Monday, the week before in each workspace. It starts on only for workspace owners. |
Retrieve your email notification settings
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/account/email-preferences | operations:general | Not used |
Also available as abusezero account email-preferences in the AbuseZero CLI, abusezero_get_email_preferences on the AbuseZero MCP server and emailPreferences() in the AbuseZero Node.js SDK.
Returns 200 with your email notification settings.
Update your email notification settings
Send only the groups that change.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
PATCH | /v1/account/email-preferences | operations:configuration | Required |
Also available as abusezero account update-email-preferences in the AbuseZero CLI, abusezero_update_email_preferences on the AbuseZero MCP server and updateEmailPreferences() in the AbuseZero Node.js SDK.
await abusezero.updateEmailPreferences({ weekly_summary: false }, "email-preferences-2026-11-10");Returns 200 with your updated email notification settings. Any other field, such as one for security email, returns INVALID_FIELD (422).
The notification object
Notifications are the ones in the dashboard's bell: your own account's, and the workspace's that your role lets you see. They never carry a code, link or other credential.
{
"object": "notification",
"id": "73492810562018437529",
"workspace": "95082035373438252677",
"kind": "webhook_endpoint.disabled",
"title": "A webhook endpoint was disabled",
"snippet": "https://hooks.example.com/abusezero stopped answering, so it was disabled.",
"unread": true,
"count": 1,
"updated_at": "2026-11-10T12:00:00.000Z",
"actions": [{ "id": "webhook_endpoint.enable", "label": "Enable endpoint" }],
"resolved": null
}| Field | Type | Description |
|---|---|---|
object | "notification" | The object type. |
id | string | The notification ID. |
workspace | string or null | The workspace it's about, or null for your own account's. |
kind | string | What it's about, such as member.access_changed. New kinds can appear within v1. |
title, snippet | string | Its words, as the bell shows them. |
unread | boolean | Whether you haven't read it yet. |
count | integer | How many times the same thing happened, when repeats fold into one notification. |
updated_at | string | When it last changed. |
actions | array | The actions you can run from it, each with its id and label. Only actions your role and this connection's scopes allow are listed. |
resolved | string or null | What happened to its action, such as "You enabled this endpoint." |
List notifications
Returns your notifications, newest first, 30 to a page, with how many are unread.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/notifications | operations:general | Not used |
Also available as abusezero notifications list in the AbuseZero CLI, abusezero_list_notifications on the AbuseZero MCP server and notifications() in the AbuseZero Node.js SDK.
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | all or unread | No | Default all. |
cursor | string | No | The next_cursor of the previous page. |
const { data, unread_count } = await abusezero.notifications({ filter: "unread" });Returns 200.
{
"object": "list",
"data": [{ "object": "notification", "id": "73492810562018437529", "unread": true }],
"next_cursor": null,
"unread_count": 1
}unread_count counts up to 100.
Mark a notification as read or unread
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
PATCH | /v1/notifications/{id} | operations:general | Required |
Also available as abusezero notifications mark in the AbuseZero CLI, abusezero_mark_notification on the AbuseZero MCP server and markNotification() in the AbuseZero Node.js SDK.
| Field | Type | Required | Description |
|---|---|---|---|
read | boolean | Yes | true marks it read, false unread. |
Returns 200 with the notification and unread_count. Another person's notification returns NOTIFICATION_NOT_FOUND (404).
Mark all notifications as read
Marks every notification you see in this workspace as read, and your own account's.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
POST | /v1/notifications/read-all | operations:general | Required |
Also available as abusezero notifications read-all in the AbuseZero CLI, abusezero_mark_all_notifications_read on the AbuseZero MCP server and markAllNotificationsRead() in the AbuseZero Node.js SDK.
Returns 201.
{ "object": "notifications_read", "unread_count": 0 }Run a notification's action
Runs one of a notification's actions, exactly as its button in the dashboard does. The thing it acts on is checked again first: when it already changed, nothing runs and resolved says so. The connection also needs the scope of the action it runs, as it would to run that action itself. webhook_endpoint.enable needs operations:configuration.
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
POST | /v1/notifications/{id}/run | operations:general | Required |
Also available as abusezero notifications run-action in the AbuseZero CLI, abusezero_run_notification_action on the AbuseZero MCP server and runNotificationAction() in the AbuseZero Node.js SDK.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | The id of one of the notification's actions. |
await abusezero.runNotificationAction("73492810562018437529", "webhook_endpoint.enable", "enable-endpoint-2026-11-10");Returns 201 with the notification and unread_count.
Errors
| Code | Status | Meaning |
|---|---|---|
OAUTH_SCOPE_REQUIRED | 403 | The connection lacks the scope of the action it runs. |
PERMISSION_REQUIRED | 403 | Your role doesn't allow the action. |
NOTIFICATION_NOT_FOUND | 404 | The notification isn't yours, isn't in this workspace or doesn't carry this action. |
INVALID_FIELD | 422 | action isn't an action AbuseZero offers. |
How is this guide?
Last updated on