Chanl

Delete Scenario

Permanently delete a scenario and its associated schedules.

Delete Scenario

Permanently removes a scenario and all schedules linked to it. Existing simulation results are preserved.

This action is irreversible. All schedules associated with this scenario will also be deleted.

Endpoint

DELETE /api/v1/scenarios/:id

curl -X DELETE "https://api.chanl.ai/api/v1/scenarios/scenario_abc123" \
  -H "Authorization: Bearer <access_token>"
const response = await fetch('https://api.chanl.ai/api/v1/scenarios/scenario_abc123', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
  },
});
const data = await response.json();
import requests

response = requests.delete(
    'https://api.chanl.ai/api/v1/scenarios/scenario_abc123',
    headers={'Authorization': f'Bearer {access_token}'},
)
data = response.json()

Path Parameters

idstringrequired

The scenario ID (e.g., scenario_abc123).

Response

Response
{
  "success": true,
  "data": {
    "message": "Scenario deleted successfully",
    "deleted_at": "2025-03-17T10:30:00Z",
    "impact": {
      "schedules_deleted": 2,
      "simulations_preserved": 156
    }
  }
}

Errors

StatusCodeDescription
401unauthorizedMissing or invalid access token
404not_foundScenario not found

Update Scenario

Update an existing scenario configuration.

Execute Scenario

Trigger an immediate simulation run for a scenario.

On this page

Delete Scenario
Endpoint
Path Parameters
Response
Errors