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

Extole User Notifications API

The User Notifications API from Extole — 8 operation(s) for user notifications.

Extole User Notifications API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Notifications. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 8 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

14 operations 8 paths 7 schemas 2 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole User Notifications API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 2 DELETE, 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

User Notifications 14
GET
/v6/notifications
List recent notifications
listNotifications 5 params → 200400401402403415429
GET
/v6/notifications/read
Get notification read cursor
getNotificationCursor → 200400401402403415429
POST
/v6/notifications/read
Mark notifications as read
updateNotificationCursor body → 200400401402403415429
GET
/v6/notifications/snoozes
List notification snoozes for the caller
listSnoozes → 200400401402403415429
POST
/v6/notifications/snoozes
Create a notification snooze for the caller
createSnooze body → 200400401402403415429
GET
/v6/notifications/snoozes/{snoozeId}
Get a notification snooze for the caller
getSnooze 1 param → 200400401402403415429
DELETE
/v6/notifications/snoozes/{snoozeId}
Delete a notification snooze for the caller
deleteSnooze 1 param → 200400401402403415429
GET
/v6/notifications/{userId}
List notifications for a user
listNotificationsByUser 6 params → 200400401402403415429
GET
/v6/notifications/{userId}/read
Get notification read cursor for a user
getNotificationCursorByUser 1 param → 200400401402403415429
POST
/v6/notifications/{userId}/read
Mark notifications as read for a user
updateNotificationCursorByUser 1 param body → 200400401402403415429
GET
/v6/notifications/{userId}/snoozes
List notification snoozes for a user
listSnoozesByUser 1 param → 200400401402403415429
POST
/v6/notifications/{userId}/snoozes
Create a notification snooze for a user
createSnoozeByUser 1 param body → 200400401402403415429
GET
/v6/notifications/{userId}/snoozes/{snoozeId}
Get a notification snooze for a user
getSnoozeByUser 2 params → 200400401402403415429
DELETE
/v6/notifications/{userId}/snoozes/{snoozeId}
Delete a notification snooze for a user
deleteSnoozeByUser 2 params → 200400401402403415429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NotificationResponse (16 properties), RestExceptionResponse (5 properties), SnoozeResponse (4 properties), SnoozeRequest (3 properties). Each schema is shown below with its type and property counts.

NotificationCursorRequest
object
1 property 1 required
SnoozeRequest
object
3 properties 3 required
NotificationResponse
object
16 properties 16 required
SnoozeResponse
object
4 properties 4 required
NotificationCursorResponse
object
1 property 1 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-user-notifications-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API