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

Allows deletion (archiving) of multiple user notifications.

Note: To get the list of notifications, for the purposes of deleting some or all of them, use the GET /api/users/{UserID}/notifications operation.

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

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to archive two notifications.

Request URL

https://{hostname}/api/users/b0a1fced-bd72-4ebe-bdfc-1d5269474fff.acmepaymentscorp/notifications/state

Sample request headers

PUT /api/users/b0a1fced-bd72-4ebe-bdfc-1d5269474fff.acmepaymentscorp/notifications/state HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/vnd.soa.v84+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "State":"archived",
  "NotificationID":[
    "notification1024.acmepaymentscorp",
    "notification1023.acmepaymentscorp"
  ]
}

Back to top

Request Headers

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

Header Description
Accept text/plain
Content-Type application/json, application/vnd.soa.v84+json
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
NotificationsState Body NotificationsState Required Contains information about the state of one or more developer portal Dashboard notifications.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the UserID of the user whose notifications were archived.

Back to top

Sample Response

The sample response below shows that the operation was successful.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Fri, 09 Feb 2018 20:34:36 GMT

Sample response body

b0a1fced-bd72-4ebe-bdfc-1d5269474fff.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
UserID String The unique ID for a specific user.

Back to top

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.

Back to top

Related Topics