DocumentationAPI Reference
API Reference

Update an alert configuration

put
https://{companyDomain}.bamboohr.com/api/v1/alert-configurations/

Updates an existing company alert configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
integer

The unique identifier of the company alert.

integer

The unique identifier of the Bamboo alert.

string
enum

The schedule for the company alert.

Allowed:
integer | null

The number of days before the alert is due.

string | null

The interval for the alert.

boolean

Whether the alert should be sent to employees.

boolean

Whether the alert should be sent to managers.

boolean

Whether the alert should be sent to admins.

integer | null

The user ID of the editor.

null

The last edited date of the company alert.

string | null

The custom message for the company alert.

string | null

The custom subject for the company alert.

string | null

The group by for the company alert.

boolean

Whether the training should be limited to required training.

string | null

The time the company alert should run at.

string | null

The time zone the company alert should run at.

boolean

Whether the alert should include position.

boolean

Whether the alert should include location.

additionalRecipientEmails
array of strings

The additional recipient emails for the company alert.

additionalRecipientEmails
employeeIds
array of strings

The employee IDs for the company alert.

employeeIds
listValueIds
array of integers

The list value IDs for the company alert.

listValueIds
filterListValueIds
array of integers

The filter list value IDs for the company alert.

filterListValueIds
userIds
array of integers

The user IDs for the company alert.

userIds
Responses

Updated 1 day ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago