DevelopersAPIReferencenotifications
Read
Mark one notification as read and return the updated row. Returns 404 if the notification does not exist or the caller cannot read it.
Authentication
Checking whether you're signed in…
PUT
header
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.
companyId*stringLength
1 <= lengthnotificationId*stringLength
1 <= lengthNotification marked as read
application/json- response
id*stringFormat
uuidcompanyId*stringFormat
uuidtype*stringThe type of notification.
recipientUserId*stringThe ID of the user who should receive this notification.
readTime*|When the notification was read. Null if unread.
Format
date-timepayload*Type-specific notification data.
createdTime*|Format
date-timecreatedUserId*string|nulllastUpdatedTime*|Format
date-timelastUpdatedUserId*string|nullcurl -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"}