Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NotificationAPI Users API

Identify and manage the users you notify.

NotificationAPI Users API is one of 7 APIs that NotificationAPI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 3 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}.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.8
Base URL
https://api.notificationapi.com/{clientId}
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

NotificationAPI Users 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 1

Identify and manage the users you notify.

POST
/users/{userId}
Identify a user
identifyUser 1 param body → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (9 properties), UserData (6 properties), PushToken (3 properties). Each schema is shown below with its type and property counts.

UserData
object
The mutable fields of a user, used on identify.
6 properties
User
object
A user you notify.
9 properties 1 required
PushToken
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notificationapi-users-api-openapi.yml Raw ↑

Other APIs NotificationAPI publishes across the network.

NotificationAPI In-App Inbox API
NotificationAPI Logs API
NotificationAPI Notifications API
NotificationAPI Schedule API
NotificationAPI Send API
NotificationAPI User Preferences API