Delete Task
DELETE/external/v1/tasks/:idPermanently deletes a task, with its subtasks, comments and attachments. Deleting a step of a playbook run removes it from the run: the run's step count goes down, and if every remaining step is done the run becomes completed.
Authentication
Requires tasks:delete permission. The task must be visible to the user who created the API key.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Task identifier (UUID) |
Request
bash
curl --request DELETE \
--url "https://app.getraze.com/external/v1/tasks/7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const taskId = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11';
const response = await axios.delete(
`https://app.getraze.com/external/v1/tasks/${taskId}`,
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
task_id = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11'
response = requests.delete(
f'https://app.getraze.com/external/v1/tasks/{task_id}',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"message": "Task deleted successfully"
}Errors
| Status | Code | Description |
|---|---|---|
| 403 | INSUFFICIENT_PERMISSIONS | Key lacks tasks:delete |
| 404 | NOT_FOUND | Task not found, or not visible to the key's creator |