NotificationAPI User Preferences API
Read and write per-user channel and opt-out preferences.
NotificationAPI User Preferences API is one of 7 APIs that NotificationAPI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Preferences. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 2.8.
Requests are made against 3 base URLs: https://api.notificationapi.com/{clientId}, https://api.eu.notificationapi.com/{clientId}, https://api.ca.notificationapi.com/{clientId}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
NotificationAPI User Preferences API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic authentication. For account-level calls the username is your clientId and the password is your clientSecret. Per-user calls (identify user, in-app i…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 DELETE, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Read and write per-user channel and opt-out preferences.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is UserPreference (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NotificationAPI 6
Other APIs NotificationAPI publishes across the network.