Incident Schedule Management

Retrieve all on-call schedule data associated with a specific customer by providing the customer_id in the path. The response includes schedule entries that define which team members are responsible for incident response during specific time intervals.

This endpoint helps ensure visibility into who is currently on duty or scheduled for upcoming shifts, enabling seamless coordination and faster incident triage.

Use cases:

• On-call visibility — View active and upcoming shifts for a customer to understand who is responsible during incidents.
• Audit and reporting — Analyze historical scheduling data to verify coverage and response availability.
• Manual coordination — Help team leads or incident managers plan shift handovers or update escalation contacts based on predefined schedules.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the system will return the schedule data, including start and end dates, months, weeks, and days of the schedule.
• If the request is unauthorized, the system will return an authentication error message.

Create a new on-call schedule for a team by submitting schedule configuration details in the request body. This allows you to assign specific team members to recurring or time-bound shifts based on custom rules.

The request body should include fields such as the team_member_id, start_date, end_date, and the time recurrence parameters including months_of_year, weeks_of_month, week_days, and time_range. These options provide flexible scheduling across daily, weekly, or monthly cycles.

Use cases:

• 24/7 incident coverage — Build reliable on-call rotations to ensure someone is always available to respond.
• Custom shift planning — Create unique patterns such as weekday-only coverage, weekend rotation, or split-shift assignments.
• Automated scheduling infrastructure — Power internal systems with rule-based, structured on-call assignments for each team.

To retrieve existing schedules for a customer, use the Get Customer Schedules endpoint.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the system will create a new schedule and return a confirmation message.
• If the request is invalid, the system will return an error message with details of the invalid fields.

Update an existing on-call schedule for a team by providing the team_id in the path and submitting the updated configuration in the request body. This allows you to modify both the timing and recurrence rules that define when a team member is expected to be on-call.

The request body should include fields such as team_member_id, start_date, end_date, and recurrence settings including months_of_year, weeks_of_month, week_days, and the time_range.

Use cases:

• Schedule correction — Fix time or date ranges for an existing schedule due to entry errors or changes in availability.
• Role reassignment — Update the assigned team_member_id to reflect staffing or rotation changes.
• Recurrence adjustments — Modify which months, weeks, or weekdays a schedule applies to as coverage needs evolve.

To view the current schedule for reference before updating, use the Get Customer Schedules endpoint.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the system will update the existing schedule and return a confirmation message.
• If the request is invalid, the system will return an error message with details of the invalid fields.

Delete an existing on-call schedule for a team member by providing the team_member_id and the created_at timestamp as query parameters. These two values uniquely identify the schedule entry that should be removed.

This endpoint is useful for cleaning up outdated shift assignments, correcting scheduling errors, or removing temporary coverage entries.

Use cases:

• Coverage cleanup — Remove outdated or duplicate schedule entries from a team member’s on-call calendar.
• Incorrect assignment fix — Delete a schedule entry created with the wrong timing or person assigned.
• Temporary shift removal — Cancel a one-time or ad hoc on-call period that is no longer needed.

To modify a schedule instead of deleting it, use Update On-Call Schedule.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the system will delete the specified on-call schedule and return a confirmation message.
• If the request is invalid, the system will return an error message with details of the invalid fields.