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

CDC app-notifications API

The app-notifications API from CDC — 1 operation(s) for app-notifications.

CDC app-notifications API is one of 14 APIs that CDC publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include app-notifications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against the base URL https://data.cdc.gov/resource.

1 operations 1 paths 6 schemas 1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://data.cdc.gov/resource
Resource Areas
1

Paths & Operations 1

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

app-notifications 1
PATCH
/api/v1/notifications
Update User Notifications
updateUserNotifications body → 200422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ValidationError (5 properties), UserResponse (4 properties), NotificationsToRender (1 property), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

ValidationError
object
5 properties 3 required
UpdateUserNotificationsRequest
object
Request to update notification acknowledgement state for the current user.
1 property 1 required
HTTPValidationError
object
1 property
UserResponse
object
User information to send to the client.
4 properties 4 required
NotificationsToRender
object
Map of booleans for each of the notificaiton keys as to whether to render frontend banners.
1 property 1 required
NotificationKeys
string
Enum class to type the values of the notifications possible for actioning on the frontend.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cdc-app-notifications-api-openapi.yml Raw ↑

Other APIs CDC publishes across the network.

CDC WONDER API
CDC Environmental Public Health Tracking Network API
CDC Content Syndication API
PHIN VADS API
CDC code-systems API
CDC conditions API
CDC configurations API
CDC events API
CDC Query API
CDC Query Connector API OpenAPI 3.0 API
CDC releases API
CDC simulator API