Cancel a Task

Overview

After a tasking request has reached an accepted or active status, sometimes it is necessary to cancel the request before it is scheduled to be collected. When canceling a task, the system will update the task status to canceled and remove the task from the active schedule. This is a terminal state and cannot be reversed by the API user. The API user is subject to any charges per the Capella Cancellation Policy.

Canceling a Task

Single Tasking Request

To cancel a single tasking request, you will send a request to the status endpoint with status set to cancelled:

PATCH https://api.capellaspace.com/task/{{taskingrequestId}}/status
{
    "status":"canceled"
}
NOTE: a value of either 'canceled' or 'cancelled' is accepted and will be returned as 'canceled'

Repeat Tasking Request

To cancel a repeat tasking request, you will send a request to the status endpoint with code set to canceled:

PATCH https://api.capellaspace.com/repeat-requests/{{repeatrequestId}}/status
{
    "code":"canceled"
}
NOTE: a value of either 'canceled' or 'cancelled' is accepted and will be returned as 'canceled'

Additional Information

For more information on tasking cancellation, see the API reference for Tasking.