curl --request PATCH \
--url http://localhost:3500/v1/notifications/preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "personal",
"channels": [
{
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": []
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
owner: 'personal',
channels: [{enabled: true, id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', events: []}]
})
};
fetch('http://localhost:3500/v1/notifications/preferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/notifications/preferences"
payload = {
"owner": "personal",
"channels": [
{
"enabled": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": []
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"owner": "personal",
"scope": "mine",
"sources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"personal": true,
"filter": "<unknown>",
"references": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"missing": true,
"type": "supplier"
}
]
}
],
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"events": [
"new_alert"
],
"readiness": "ready"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The channel or authorization cannot accept this operation. Read the error description before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Update notification preferences
Choose owner in the JSON body: personal changes require Write, organization changes require Admin. Updates scope and channel settings atomically; any failure rolls back the entire request. Scope is personal-only and shared across personal channels. Omitted channels and fields are preserved; supplied events replace selections without changing enablement. Channel IDs must be unique and belong to the selected owner. Personal email updates refresh the verified primary address. The first personal save retains the disabled email anchor. Scope edits affect future scheduling.
curl --request PATCH \
--url http://localhost:3500/v1/notifications/preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "personal",
"channels": [
{
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": []
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
owner: 'personal',
channels: [{enabled: true, id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', events: []}]
})
};
fetch('http://localhost:3500/v1/notifications/preferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/notifications/preferences"
payload = {
"owner": "personal",
"channels": [
{
"enabled": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": []
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"owner": "personal",
"scope": "mine",
"sources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"personal": true,
"filter": "<unknown>",
"references": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"missing": true,
"type": "supplier"
}
]
}
],
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"events": [
"new_alert"
],
"readiness": "ready"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The channel or authorization cannot accept this operation. Read the error description before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Body
- Option 1
- Option 2
- Option 3