Skip to main content
DELETE
/
v1
/
delete-schedule
/
{schedule_id}
Delete Schedule
curl --request DELETE \
  --url https://api.getbluejay.ai/v1/delete-schedule/{schedule_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "status": "success",
  "message": "<string>"
}
Integration Prompt for AI Agents
# Bluejay — Testing & Monitoring Platform for Conversational AI Agents

You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.

## Delete Schedule — DELETE /v1/delete-schedule/{schedule_id}

**Endpoint:** DELETE `https://api.getbluejay.ai/v1/delete-schedule/{schedule_id}`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| schedule_id | string |  |
| X-API-Key | string | API key required to authenticate requests. |

### Example
**DELETE request:**
```python
import requests

def delete_schedule(schedule_id: str, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/delete-schedule/{schedule_id}"
    headers = {"X-API-Key": api_key}
    response = requests.delete(url, headers=headers)
    response.raise_for_status()
    return response.json()
```

### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error.

### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?

Then implement the integration, export it, and confirm it compiles/passes lint.
Given the schedule ID, this endpoint permanently deletes the schedule.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
schedule_id
string
required

Response

Successful Response

​
status
enum<string>
required

The status of the delete operation.

Available options:
success,
error
​
message
string
required

A message providing additional details about the operation.