Activities
Cancel Activity
Cancel an activity that is in READY status.
PATCH /api/activities/:id/cancel
Cancel an activity. Only activities in READY status can be canceled.
Auth: Required — CANCEL_ACTIVITY permission
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | UUID | Activity ID |
Example
curl -X PATCH https://api.reten.ai/api/activities/ee0e8400-e29b-41d4-a716-446655440000/cancel \
-H "Authorization: Bearer <token>" \
-H "x-tenant-id: <tenant-id>"import axios from 'axios';
const response = await axios.patch(
'https://api.reten.ai/api/activities/ee0e8400-e29b-41d4-a716-446655440000/cancel',
{},
{
headers: {
Authorization: 'Bearer <token>',
'x-tenant-id': '<tenant-id>',
},
}
);Response 200 OK
{
"id": "ee0e8400-e29b-41d4-a716-446655440000",
"status": "CANCELED"
}Error Responses
| Status | Description |
|---|---|
400 | Activity is not in READY status |
404 | Activity not found |