PUT /api/users/{UserID}/notifications/{NotificationID}/state

Changes the state of a user's notification (for example, archived, read).

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/users/{UserID}/notifications/{NotificationID}/state

Sample Request

The example below shows a request to archive a notification. In the user interface, this is generally done after the user has viewed the notification.

Sample Request URL

https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/notifications/notification30170.acmepaymentscorp/state

Sample request headers

PUT /api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/notifications/notification30170.acmepaymentscorp/state HTTP/1.1
Host: {hostname}
Accept: text/html, */*; q=0.01
Content-Type: text/plain; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

archived

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	text/plain
Content-Type	text/plain
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
NotificationID	Path	string	Required	The unique ID for a specific instance of a notification on a specific user's Dashboard.
state	Body	string	Required	The new notification state; for example, archived.

Response

If successful, this operation returns HTTP status code 200, with the NotificationID in the response message.

Sample Response

The sample response below shows that the state of the specified notification has been changed.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Fri, 17 May 2013 15:38:29 GMT

Sample response body

notification30170.acmepaymentscorp

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

Response Body

Name	Type	Description
NotificationID	string	The unique ID for a specific instance of a notification on a specific user's Dashboard.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics