Sign in
Notifications

Mark a notification as read

Changed on

Marks a single in-app notification as read for the authenticated user. Fully native + ownership-scoped via mark_read_bulk: an id that is missing, owned by another user, or in a non-SENT/READ state yields 404. Idempotent: an already-READ owned notification returns 200.

post/notifications/{id}/mark-read{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required
idstring required

Request body

idstring required
titlestring required
notification_typestring required
statusstring required
bodystring required

Render the body template with the best-available context.

Priority:

  1. context_used — the context that was recorded at send time (on model rows, set by the backend when the notification was processed).
  2. context_kwargs — the original kwargs passed at creation time.
  3. Empty dict — render the template with no context (graceful degradation).

Returns an empty string on rendering failure so the response always serialises.

createdstring nullable required

Return the creation timestamp as ISO 8601 string, or None for dataclasses.

The vintasend Notification dataclass has no created attribute; only the vintasend_django ORM model does.

modifiedstring nullable required

Return the last-modified timestamp as ISO 8601 string, or None for dataclasses.

In vintasend 1.2.0 the Notification dataclass carries modified; ORM rows also have it. Returns None when the attribute is absent or None.

Response

Notification marked as read. Returns the updated notification.

idstring required
titlestring required
notification_typestring required
statusstring required
bodystring required

Render the body template with the best-available context.

Priority:

  1. context_used — the context that was recorded at send time (on model rows, set by the backend when the notification was processed).
  2. context_kwargs — the original kwargs passed at creation time.
  3. Empty dict — render the template with no context (graceful degradation).

Returns an empty string on rendering failure so the response always serialises.

createdstring nullable required

Return the creation timestamp as ISO 8601 string, or None for dataclasses.

The vintasend Notification dataclass has no created attribute; only the vintasend_django ORM model does.

modifiedstring nullable required

Return the last-modified timestamp as ISO 8601 string, or None for dataclasses.

In vintasend 1.2.0 the Notification dataclass carries modified; ORM rows also have it. Returns None when the attribute is absent or None.

Changes