REST API: Delete Notifications

Last Updated: July 08, 2015

Description

Delete one or more notifications in your company. We will handle batches of up to 50 notifications at a time. More than 50 notifications will result in a 413 - Request entity too large error.

Resource Information

HTTP Method DELETE
Endpoint https://rest.tsheets.com/api/v1/notifications
Authentication Token header required. See authentication section
Request format Everything is handled through the request uri on a DELETE, the same as a GET.
Response format json
Response object Notification

Available Filters

ids:
required
Integer. Comma separated list of notification ids you'd like to delete. Note that notifications are actually deleted, not archived.

Status Codes

Each notification that is deleted will come back with a _status_code and _status_message that will indicate whether the notification was deleted successfully. If there was a problem deleting a notification, there may also be an additional field, _status_extra, which will contain more details about the failure.

_status_code Meaning
200 OK. Notification was deleted successfully.
404 Not Found. Notification either has never existed or has already been delivered or deleted.
417 Expectation Failed. Something went wrong for this notification. See the _status_extra value for more detail.

Examples

Delete two notifications.
Note: The code example below references notification ids that will need to be substituted with ids associated with your TSheets account.

## REQUEST
curl -H "Authorization: Bearer <Access-Token>" -X DELETE -i "https://rest.tsheets.com/api/v1/notifications?ids=135694294,135694494"


## RESPONSE
HTTP/1.1 200 OK
Content-Type: application/json

{
 "results": {
  "notifications": {
   "135694294": {
    "_status_code": 200,
    "_status_message": "OK, deleted",
    "id": "135694294"
   },
   "135694494": {
    "_status_code": 200,
    "_status_message": "OK, deleted",
    "id": "135694494"
   }
  }
 }
}