Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{ "detail": [ { "loc": [ "<string>" ], "msg": "<string>", "type": "<string>" } ] }
Get the schedule configuration for a campaign.
campaign_id
{ "schedule_type": "immediate", "scheduled_at": null, "recurring_config": null }
{ "schedule_type": "scheduled", "scheduled_at": "2024-02-15T09:00:00Z", "recurring_config": null }
{ "schedule_type": "recurring", "scheduled_at": "2024-02-15T09:00:00Z", "recurring_config": { "frequency": "weekly", "interval": 1, "days_of_week": [1, 2, 3, 4, 5], "time": "09:00", "time_zone": "America/New_York", "end_date": "2024-12-31" } }
schedule_type
immediate
scheduled
recurring
scheduled_at
recurring_config
frequency
daily
weekly
monthly
interval
days_of_week
time
time_zone
end_date
curl -X GET "https://api.burki.dev/api/v1/campaigns/42/schedule" \ -H "Authorization: Bearer YOUR_API_KEY"
import requests from datetime import datetime response = requests.get( "https://api.burki.dev/api/v1/campaigns/42/schedule", headers={"Authorization": "Bearer YOUR_API_KEY"} ) schedule = response.json() if schedule["schedule_type"] == "immediate": print("Campaign set for immediate execution") elif schedule["schedule_type"] == "scheduled": scheduled_at = datetime.fromisoformat(schedule["scheduled_at"].replace("Z", "+00:00")) print(f"Campaign scheduled for: {scheduled_at}") elif schedule["schedule_type"] == "recurring": config = schedule["recurring_config"] print(f"Recurring {config['frequency']} at {config['time']} {config['time_zone']}")
const response = await fetch("https://api.burki.dev/api/v1/campaigns/42/schedule", { headers: { "Authorization": "Bearer YOUR_API_KEY" } }); const schedule = await response.json(); switch (schedule.schedule_type) { case "immediate": console.log("Campaign set for immediate execution"); break; case "scheduled": console.log(`Campaign scheduled for: ${schedule.scheduled_at}`); break; case "recurring": const config = schedule.recurring_config; console.log(`Recurring ${config.frequency} at ${config.time} ${config.time_zone}`); break; }
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Successful Response