API referenceNotifications

Change a preference

Set one event's channels, for the business or for yourself. Anyone may silence their own mail. Changing what the *business* hears is `NOTIFICATION_MANAGE`, because switching off payout failures for everybody is a decision with consequences for people who did not make it.

PUT
/api/b/v1/notifications/settings

Set one event's channels, for the business or for yourself.

Anyone may silence their own mail. Changing what the business hears is NOTIFICATION_MANAGE, because switching off payout failures for everybody is a decision with consequences for people who did not make it.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Whether we notify about one kind of event, and where. IN-302.

Response Body

application/json

application/json

curl -X PUT "https://example.com/api/b/v1/notifications/settings" \  -H "Content-Type: application/json" \  -d '{    "event": "payout.failed"  }'
{  "event": "string",  "email_enabled": true,  "in_app_enabled": true,  "scope": "string"}

What we notify about GET

Absent means on. An event with no row is enabled on both channels — a business that has never opened this screen should still hear that a payout failed, so the useful default cannot require a row to exist.

Your notifications GET

Scoped to the caller, always. There is no parameter for whose inbox to read. A notification is addressed to a person, and an endpoint that could be pointed at somebody else's would hand any member the finance team's mail.