v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Subscribers

Complete a notification action

Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier notificationId and action type actionType.

patch/v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/complete

Path parameters

subscriberIdstring required

The identifier of the subscriber

notificationIdstring required

The identifier of the notification

actionType'primary' | 'secondary' required

The type of action (primary or secondary)

Query parameters

contextKeysstring[]

Context keys for filtering

Headers

idempotency-keystring

A header for idempotency purposes

Response

idstring required

Unique identifier of the notification

transactionIdstring required

Transaction identifier of the notification

subjectstring

Subject of the notification

bodystring required

Body content of the notification

isReadboolean required

Whether the notification has been read

isSeenboolean required

Whether the notification has been seen

isArchivedboolean required

Whether the notification has been archived

isSnoozedboolean required

Whether the notification is snoozed

snoozedUntilstring nullable

ISO timestamp when the notification will be unsnoozed

deliveredAtstring[]

Timestamps when the notification was delivered

createdAtstring required

ISO timestamp when the notification was created

readAtstring nullable

ISO timestamp when the notification was read

firstSeenAtstring nullable

ISO timestamp when the notification was first seen

archivedAtstring nullable

ISO timestamp when the notification was archived

avatarstring

Avatar URL for the notification

Channel type through which the message is sent

tagsstring[]

Tags associated with the notification

dataobject

Custom data payload of the notification

severity'high' | 'medium' | 'low' | 'none' required

Severity of the workflow