Creates an alert configuration for the authenticated company from one of BambooHR's alert templates, and returns the stored configuration, including its server-assigned id, as a single JSON object.
Use this to add a configuration the company does not have yet. To overwrite one that already exists, use Replace Alert Configuration (replace-alert-configuration) instead; to see what is already configured, use List Alert Configurations (list-alert-configurations). bambooAlertId names the alert template the configuration is built on and comes from List Alert Templates (list-alert-templates). An alert configuration sends scheduled email to people; to receive a programmatic HTTP callback when employee data changes instead, use Webhooks > Create Webhook (create-webhook).
The configuration is live as soon as it is created and begins sending on the schedule it defines. Nothing limits a template to one configuration, so repeating this call with the same bambooAlertId adds a second configuration rather than replacing the first, and no endpoint deletes an alert configuration once it exists. The returned object also carries additionalRecipientEmails, employeeIds, listValueIds, and userIds; this API never stores those, so scope an alert's audience with filterListValueIds and the sendTo* properties instead.
Access is all-or-nothing rather than per-record. An authenticated caller without view access to the company's Email Alerts settings receives 403 instead of a partial success.
OAuth Scopes: alerts.write
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthorized.
