Mark Notification Read

POST

https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/:firm_slug/notifications/:notification_id/read

POST

/api/v1/firms/:firm_slug/notifications/:notification_id/read

curl -X POST https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/notifications/1/read \
     -H "Authorization: <apiKey>"

{
  "data": {
    "id": 1,
    "firm_id": 1,
    "reminder_id": 1,
    "recipient_user_id": 1,
    "recipient_email": "string",
    "channel": "IN_APP",
    "status": "PENDING",
    "read_at": "2024-01-15T09:30:00Z",
    "sent_at": "2024-01-15T09:30:00Z",
    "failure_reason": "string",
    "due_at_snapshot": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "reminder_title": "string",
    "reminder_description_html": "string",
    "reminder_due_at": "2024-01-15T09:30:00Z",
    "reminder_status": "ACTIVE",
    "client_membership_id": 1
  },
  "status": "success"
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

notification_idintegerRequired

firm_slugstringRequired3-64 characters

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error