---
title: "Create On-Call schedule overrides"
method: POST
path: "/api/v2/on-call/schedules/{schedule_id}/overrides"
tags: ["On-Call"]
---

# Create On-Call schedule overrides

`POST /api/v2/on-call/schedules/{schedule_id}/overrides`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrides`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/on-call/schedules/:schedule_id/overrides/post.ts> (a function with typed inputs; its response is checked against the schema)

Create one or more overrides for the specified On-Call schedule.

## Path parameters

- `schedule_id` string, required

## Query parameters

- `include` string

## Request body

- CreateOverridesRequest: Request to create one or more on-call schedule overrides. You can create up to 25 overrides in a single request.
  - `data` CreateOverrideRequestData[], required: A list of on-call schedule overrides to create.
    - `attributes` CreateOverrideRequestAttributes, required: Attributes for creating an on-call schedule override.
      - `end` string, date-time, required: The end time of the override.
      - `start` string, date-time, required: The start time of the override.
    - `relationships` CreateOverrideRequestRelationships: Relationships to set when creating an on-call schedule override.
      - `overridden_user` OverrideRelationshipsUser: Defines the relationship between an override and one of its associated users.
        - `data` OverrideRelationshipsUserData, required: A reference to a user, containing the user's ID and resource type.
          - `id` string, required: The unique identifier of the user.
          - `type` 'users', required: Indicates that the related resource is of type `users`.
      - `user` OverrideRelationshipsUser: Defines the relationship between an override and one of its associated users.
        - `data` OverrideRelationshipsUserData, required: A reference to a user, containing the user's ID and resource type.
          - `id` string, required: The unique identifier of the user.
          - `type` 'users', required: Indicates that the related resource is of type `users`.
    - `type` 'overrides', required: Indicates that the resource is of type `overrides`.

## Response `201`

Created

- OverrideCreateResponse: The on-call schedule overrides that were created, and any related included resources (such as users).
  - `data` OverrideData[], required: The on-call schedule overrides that were created.
    - `attributes` OverrideAttributes: Attributes for an on-call schedule override.
      - `end` string, date-time: The end time of the override.
      - `inactive` boolean: Whether the override is inactive (for example, because its time range has ended).
      - `start` string, date-time: The start time of the override.
    - `id` string, required: The unique identifier of the override.
    - `relationships` OverrideRelationships: Relationships for an on-call schedule override.
      - `overridden_user` OverrideRelationshipsUser: Defines the relationship between an override and one of its associated users.
        - `data` OverrideRelationshipsUserData, required: A reference to a user, containing the user's ID and resource type.
          - `id` string, required: The unique identifier of the user.
          - `type` 'users', required: Indicates that the related resource is of type `users`.
      - `schedule` OverrideRelationshipsSchedule: Defines the relationship between an override and the schedule it belongs to.
        - `data` OverrideRelationshipsScheduleData, required: A reference to the schedule the override belongs to, containing the schedule's ID and resource type.
          - `id` string, required: The unique identifier of the schedule.
          - `type` 'schedules', required: Indicates that the related resource is of type `schedules`.
      - `user` OverrideRelationshipsUser: Defines the relationship between an override and one of its associated users.
        - `data` OverrideRelationshipsUserData, required: A reference to a user, containing the user's ID and resource type.
          - `id` string, required: The unique identifier of the user.
          - `type` 'users', required: Indicates that the related resource is of type `users`.
    - `type` 'overrides', required: Indicates that the resource is of type `overrides`.
  - `included` OverrideIncluded[]: Related resources referenced in the overrides' relationships, such as users.
    - `attributes` ScheduleUserAttributes: Provides basic user information for a schedule, including a name and email address.
      - `color` string: The user's on-call color, as a hex code (for example, `#FF0000`). Included only when `user.color` is requested in the `include` parameter.
      - `email` string: The user's email address.
      - `name` string: The user's name.
      - `status` 'active' | 'deactivated' | 'pending': The user's status.
    - `id` string, required: The unique user identifier.
    - `type` 'users', required: Users resource type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)