Delete Task

It’s simple to use: you only need to submit your access_key and the task id. The API will delete the scheduled task for your account.

​

Getting started

​

REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

​

HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

​

API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

​

Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs. To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests. For POST and PATCH requests, you can include your access key in the request body as a JSON object. You can also use the X-Access-Key header to pass your access key. You can find your access key in your account dashboard.

​

Base URL

https://api.screenshotmax.com/v1/tasks

​

Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return an empty response.

DELETE https://api.screenshotmax.com/v1/tasks/5650820808835072
? access_key=YOUR_ACCESS_KEY

This was a successful request, so the API returned a 204 Created response.

​

Path parameters

​

Query parameters

​

Response parameters

The API will return a 204 No Content response if the task was successfully deleted. There is no response body.

​

Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.