Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateUserNotificationStatus

Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.

Request Syntax


POST /users/InstanceId/UserId/notifications/NotificationId HTTP/1.1
x-amz-last-modified-time: LastModifiedTime
x-amz-last-modified-region: LastModifiedRegion
Content-type: application/json

{
   "Status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

LastModifiedRegion

The AWS Region where the notification status was last modified. Used for cross-region replication.

Pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

LastModifiedTime

The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.

NotificationId

The unique identifier for the notification.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

UserId

The identifier of the user whose notification status is being updated.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Status

The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.

Type: String

Valid Values: READ | UNREAD | HIDDEN

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429