Complete Task
PATCH/external/v1/tasks/:id/completeMarks a task as completed. It is a shortcut for Update Task Status with status: completed, and it is idempotent: calling it on a task that is already completed changes nothing. To reopen a task, use Update Task Status with pending.
Authentication
Requires tasks:write 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 PATCH \
--url "https://app.getraze.com/external/v1/tasks/7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11/complete" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const taskId = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11';
const response = await axios.patch(
`https://app.getraze.com/external/v1/tasks/${taskId}/complete`,
null,
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
task_id = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11'
response = requests.patch(
f'https://app.getraze.com/external/v1/tasks/{task_id}/complete',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"data": {
"id": "7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11",
"status": "completed",
"is_completed": true,
"completed_at": "2026-10-19T14:02:11.000Z",
"completed_by": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" }
},
"changed": true,
"next_occurrence_id": "5349488a-e097-4cd6-980d-ad30c553c7ab"
}next_occurrence_id is set when the task is recurring and a next occurrence was created; otherwise it is null.
Errors
| Status | Code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | The task is a step of a cancelled playbook run |
| 404 | NOT_FOUND | Task not found, or not visible to the key's creator |