SaaSFlow
DevelopersAPIReferencenotifications

Read

Mark one notification as read and return the updated row. Returns 404 if the notification does not exist or belongs to another company.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
PUT
/companies/{companyId}/notifications/{notificationId}/read

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length
notificationId*string
Length1 <= length

Response Body

application/json

application/json

curl -X PUT "https://example.com/companies/string/notifications/string/read"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "type": "string",  "recipientUserId": "string",  "readTime": "2019-08-24T14:15:22Z",  "payload": {    "property1": null,    "property2": null  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Batch delete

Delete several notifications in one call by passing their ids. Without cross-user rights a caller only deletes notifications addressed to themselves; ids outside that scope, or belonging to another company, are skipped instead of failing the batch, so a success response does not guarantee every id was removed. Deletion is permanent. To clear the unread badge while keeping the history, use `read-all`.

Read all

Mark every unread notification for the calling user in this company as read, and return how many rows changed. Other users' notifications are untouched.