Notification

Get a notification for the context user. Mark a notification as read, unread, seen, or unseen.

Resource

/connect/notifications/notificationId

Available since version

49.0

HTTP methods

GET, PATCH

Request parameters for GET

Parameter	Return Type	Description	Required or Optional	Available Version
`trimMessages`	Boolean	Specifies whether the content of a notification is trimmed (`true`) or returned in full (`false`). If `true`, the title of a notification returns up to 120 characters and the body returns up to 320 characters. If `false`, the title of a notification returns up to 250 characters and the body returns up to 750 characters. If unspecified, the default is `true`.	Optional	50.0

Request body for PATCH

Root XML tag

<notification>

JSON example

1{ "read" : "true" }

Properties

Name	Type	Description	Required or Optional	Available Version
`read`	Boolean	Marks a notification as read (`true`) or unread (`false`). If a notification is marked as read, it is also marked as seen. If you set `read` to `true` and `seen` to `false`, you get an error.	Required if `seen` isn’t specified	49.0
`seen`	Boolean	Marks a notification as seen (`true`) or unseen (`false`).	Required if `read` isn’t specified	49.0

Request parameters for PATCH

Parameter	Type	Description	Required or Optional	Available Version
`read`	Boolean	Marks a notification as read (`true`) or unread (`false`).	Required if `seen` isn’t specified	49.0
`seen`	Boolean	Marks a notification as seen (`true`) or unseen (`false`).	Required if `read` isn’t specified	49.0

Response body for GET and PATCH

Notification

Connect REST API Developer Guide