POST /api/users/{UserID}/delete-board-items

Deletes multiple specified board item notifications on the Action Dashboard for the specified user.

Note: To get the list of Board item IDs, for the purpose of deleting some or all of them, use the GET /api/users/{UserID}/feeds/homefeed 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

POST

URL

https://{hostname}/api/users/{UserID}/delete-board-items

Sample Request

The example below shows a request to delete 10 Board item IDs. In this example they are all discussion items.

Sample Request URL

https://{hostname}/api/users/users/ef676bf9-bbc9-43eb-b5dd-8c1997ce88bf.acmepaymentscorp/delete-board-items

Sample request headers

Host: {hostname}
Accept: */*
Content-Type: application/json
Cookie: AtmoAuthToken_acmepaymentscorp=TokenID%3D08262027-97b0-4c8f-84ca-4d8c90a080e7%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3Aa3af316d-99e2-48a1-8f86-04999dc40dab%2CissueTime%3D1615326753171%2CexpirationTime%3D1615328613163%2CUserName%3Dadminacmepaymentscorp%2CUserFDN%3Da3af316d-99e2-48a1-8f86-04999dc40dab%252Eacmepaymentscorp...
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "BoardItemID":[
    "ticket10461.acmepaymentscorp",
    "discussion20970.acmepaymentscorp",
    "discussion20969.acmepaymentscorp",
    "discussion20968.acmepaymentscorp",
    "discussion20967.acmepaymentscorp",
    "discussion20966.acmepaymentscorp",
    "discussion20965.acmepaymentscorp",
    "discussion20964.acmepaymentscorp",
    "discussion20963.acmepaymentscorp",
    "discussion20961.acmepaymentscorp"
  ]
}

Request Headers

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

Header	Description
Accept	text/plain
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v2019+json
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.
BoardItemFDNs	Body	BoardItemFDNs[ ]	Required	An array of one or more BoardItemID values. In this context, it is an array of Board items to be deleted.

Response

If successful, this operation returns HTTP status code 200, with a confirmation message.

Sample Response

The sample response below shows successful completion of this operation. All the Action Dashboard items listed in the request were deleted (see sample request above).

Sample response headers

Status: 200 OK
Content-Type: 	text/plain
Date: Tue, 09 Mar 2021 21:55:54 GMT

Sample response body

10 of 10 board items successfully deleted.

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
Message	String	A text message indicating how many Board items were deleted. For example: 10 of 10 board items successfully deleted.

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