---
title: "Create an alert configuration"
method: POST
path: "/api/v1/alert-configurations"
tags: ["Alert Configurations", "Public API"]
---

# Create an alert configuration

`POST /api/v1/alert-configurations`

Creates a new company alert configuration.

OAuth Scopes: alerts.write

## Request body

- CompanyAlertDataObject
  - `id` integer — The unique identifier of the company alert.
  - `bambooAlertId` integer — The unique identifier of the Bamboo alert.
  - `schedule` 'daily' | 'weekly' | 'monthly' | 'quarterly' — The schedule for the company alert.
  - `dueWithin` integer, nullable — The number of days before the alert is due.
  - `dueInterval` string, nullable — The interval for the alert.
  - `sendToEmployee` boolean — Whether the alert should be sent to employees.
  - `sendToManager` boolean — Whether the alert should be sent to managers.
  - `sendToAdmin` boolean — Whether the alert should be sent to admins.
  - `editorUserId` integer, nullable — The user ID of the editor.
  - `lastEdited` unknown
  - `customMessage` string, nullable — The custom message for the company alert.
  - `customSubject` string, nullable — The custom subject for the company alert.
  - `groupBy` string, nullable — The group by for the company alert.
  - `limitTrainingToRequired` boolean — Whether the training should be limited to required training.
  - `runAtTime` string, nullable — The time the company alert should run at.
  - `runAtTimeZone` string, nullable — The time zone the company alert should run at.
  - `includePosition` boolean — Whether the alert should include position.
  - `includeLocation` boolean — Whether the alert should include location.
  - `additionalRecipientEmails` string[] — The additional recipient emails for the company alert.
  - `employeeIds` string[] — The employee IDs for the company alert.
  - `listValueIds` integer[] — The list value IDs for the company alert.
  - `filterListValueIds` integer[] — The filter list value IDs for the company alert.
  - `userIds` integer[] — The user IDs for the company alert.

## Response `201`

Created

- CompanyAlertDataObject
  - `id` integer — The unique identifier of the company alert.
  - `bambooAlertId` integer — The unique identifier of the Bamboo alert.
  - `schedule` 'daily' | 'weekly' | 'monthly' | 'quarterly' — The schedule for the company alert.
  - `dueWithin` integer, nullable — The number of days before the alert is due.
  - `dueInterval` string, nullable — The interval for the alert.
  - `sendToEmployee` boolean — Whether the alert should be sent to employees.
  - `sendToManager` boolean — Whether the alert should be sent to managers.
  - `sendToAdmin` boolean — Whether the alert should be sent to admins.
  - `editorUserId` integer, nullable — The user ID of the editor.
  - `lastEdited` unknown
  - `customMessage` string, nullable — The custom message for the company alert.
  - `customSubject` string, nullable — The custom subject for the company alert.
  - `groupBy` string, nullable — The group by for the company alert.
  - `limitTrainingToRequired` boolean — Whether the training should be limited to required training.
  - `runAtTime` string, nullable — The time the company alert should run at.
  - `runAtTimeZone` string, nullable — The time zone the company alert should run at.
  - `includePosition` boolean — Whether the alert should include position.
  - `includeLocation` boolean — Whether the alert should include location.
  - `additionalRecipientEmails` string[] — The additional recipient emails for the company alert.
  - `employeeIds` string[] — The employee IDs for the company alert.
  - `listValueIds` integer[] — The list value IDs for the company alert.
  - `filterListValueIds` integer[] — The filter list value IDs for the company alert.
  - `userIds` integer[] — The user IDs for the company alert.

## Other responses

- `400` — Bad request
- `403` — Forbidden
- `500` — Internal server error

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/versions/19ebf391a399/schema)