API task deletion

You can delete tasks in batches, with the task deletion endpoint. You can only delete tasks in the New state, in order to prevent deleting tasks which are being annotated.

Task archival callback

Should you require it, you can track task archivals using a task archival webhook. This will get triggered if a task is deleted using the API or by one of our team members manually. It will not get triggered if the entire project is archived.

Sama Platform HTTP request

Sama Platform will send an API request when a task is archived.

Method: POST

Header: Content-Type: application/json

URL: archival callback URL defined during project set up

Authentication: Callbacks can be authenticated in one of the following ways:

basic http auth (specify a username/password)
access_key (specify an access_key in the callback URL)
token based (specify a token in an X-Auth-Token header)
HMAC-SHA-256 (specify the X-wsm-date and signed Authorization header)

Body: Example callback

{
  "success": true,
  "tasks": [
    {
      "id": "51e77305ff1d8131a4000011",
      "project_id": 117,
      "archived_at": "20130715T04:45",
      "user_id": 272
    }
  ]
}

Callback HTTP response

Success

The Sama Platform will expect an appropriate response upon a successful post to
the archival callback URL.

Code: 200..299

Body: not required

Failure

Any response code other than 2xx will be treated as a failed attempt to reach
the callback. The Sama Platform will retry posting a given payload to the
callback a total of five times, after which the callback will be considered
unreachable and the Sama Platform will no longer attempt to post the failed
payload to the callback.