Update notification preferences
PUT
/v1/notifications/preferencesPatch one or more event-category notification preferences for the authenticated user.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| preferences | object | Yes | — |
| preferences.agentRuns | boolean | No | — |
| preferences.permissionRequests | boolean | No | — |
| preferences.assignedWork | boolean | No | — |
| preferences.taskActivity | boolean | No | — |
| preferences.invitations | boolean | No | — |
| preferences.productUpdates | boolean | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Updated notification preferencesapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| preferences | object | Yes | — |
| preferences.agentRuns | boolean | Yes | Notify about completion and failure of threads, schedules, and triggers. |
| preferences.permissionRequests | boolean | Yes | Notify when an agent needs approval or additional tool access. |
| preferences.assignedWork | boolean | Yes | Notify about human task assignments and review requests. |
| preferences.taskActivity | boolean | Yes | Notify about activity on subscribed project tickets. |
| preferences.invitations | boolean | Yes | Notify about team and organization invitations. |
| preferences.productUpdates | boolean | Yes | Show product announcements and release information. |
400Invalid notification preferences
None.
401Authentication required
None.