CAcardda
Notification

Mark a notification as read

Marks a single notification (of the current company, resolved from the company-id header) as read.

post/v1/notifications/{id}/mark_as_read

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/notifications/{id}/mark_as_read
  • Auth
    HTTP bearer

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Response

The updated notification.

idstring uuid required
typestring nullable

Notification subclass, e.g. TransactionApprovedNotifier::Notification.

event_idstring uuid
recipient_typestring
recipient_idstring

Firebase UID of the recipient user.

read_atstring date-time nullable

Timestamp the notification was read; null when unread.

seen_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Example response

{
  "recipient_type": "User"
}

Changes

No recorded changes to this operation across all 1 revision of this API.