Skip to main content

Cancel Task

Endpoint​

URL: /api/v6.1/task/cancel Method: POST

Request Headers​

Content-Type: application/json
X-API-KEY: <your_api_key>

Request Body​

| Field | Data Type | Description |
|--------|-------------|--------|
| task_code | string | The task code to cancel. |\

{
    "task_code": "Task.0002[UP]"
}

Request Example​

curl --location 'https://xxxxx.getflycrm.com/api/v6.1/task/cancel' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <your_api_key>' \
--header 'Cookie: v6_getflycrm_session=<your_session_token>' \
--data '{
    "task_code": "Task.0002[UP]"
}'

Response​

{
    "message": "Task canceled successfully",
    "data": {
        "task_code": "Task.0002[UP]"
    }
}

Description of Fields in Response​

| Field | Data Type | Description |
|--------|-------------|--------|
| message | string | API status message. |
| data.task_code | string | The code of the canceled task. |\

Notes​

  • This API is used to cancel a task based on task_code.
  • If successful, the API returns the message "Task canceled successfully" along with the task_code of the canceled task.