API reference › Notifications › Global event trigger notifications

Store or update global event trigger notifications

POST /v1/settings/global-event-trigger-notifications

Scope
settings_notifications_preferences:edit
Roles
admin, scheduler

Creates new notifications or updates existing ones

Parameters

None of its own.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

Global event trigger notification settings

FieldTypeDescription
deliveryInAppboolean or null

Enable in-app notifications for delivery

Example true.

deliveryEmailboolean or null

Enable email notifications for delivery

Example true.

deliverySmsboolean or null

Enable SMS notifications for delivery

Example true.

reminderInAppboolean or null

Enable in-app notifications for reminders

Example true.

reminderEmailboolean or null

Enable email notifications for reminders

Example true.

reminderSmsboolean or null

Enable SMS notifications for reminders

Example true.

summaryTimestring or null

Time for daily summary (HH:MM:SS format)

Example 17:30:00.

leadInAppboolean or null

Enable in-app notifications for leads

Example true.

leadEmailboolean or null

Enable email notifications for leads

Example true.

leadSmsboolean or null

Enable SMS notifications for leads

Example true.

leadTimeinteger or null

How long before a work item the reminder goes out, in leadUnit. Between 5 minutes and 7 days. Required when leadInApp or leadEmail is on, or leadSms once SMS is set up.

min 1. Example 4.

leadUnitstring or null

Required with leadTime.

One of: minutes, hour. Example hour.

dailySummaryEnabledboolean or null

Turns on the daily summary. summaryTime is then required if a reminder channel is on.

Example true.

dailySummaryRecipientsarray of string or null

Required, with at least one item, when dailySummaryEnabled is true.

weeklySummaryEnabledboolean or null

Example false.

weeklySummaryTimestring or null

HH:MM:SS

Example 08:00:00.

weeklySummaryDaystring or null

Required when weeklySummaryEnabled is true.

One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

weeklySummaryRecipientsarray of string or null

Required, with at least one item, when weeklySummaryEnabled is true.

useSingleEmailAddressboolean or null

Whether to use a single email address for all communications

Example true.

globalEmailAddressstring

Required when useSingleEmailAddress is true.

Example user@example.com.

Example

JSON
{
  "deliveryInApp": true,
  "deliveryEmail": true,
  "deliverySms": true,
  "reminderInApp": true,
  "reminderEmail": true,
  "reminderSms": true,
  "summaryTime": "17:30:00",
  "leadInApp": true,
  "leadEmail": true,
  "leadSms": true,
  "leadTime": 4,
  "leadUnit": "hour",
  "dailySummaryEnabled": true,
  "dailySummaryRecipients": [
    "Scheduler"
  ],
  "weeklySummaryEnabled": false,
  "useSingleEmailAddress": true,
  "globalEmailAddress": "user@example.com"
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/global-event-trigger-notifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"deliveryInApp":true,"deliveryEmail":true,"deliverySms":true,"reminderInApp":true,"reminderEmail":true,"reminderSms":true,"summaryTime":"17:30:00","leadInApp":true,"leadEmail":true,"leadSms":true,"leadTime":4,"leadUnit":"hour","dailySummaryEnabled":true,"dailySummaryRecipients":["Scheduler"],"weeklySummaryEnabled":false,"useSingleEmailAddress":true,"globalEmailAddress":"user@example.com"}'

Try it

Responses

200 Successful operation

Successful operation

JSON
{
  "success": true,
  "message": "Configuration updated successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Configuration updated successfully.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.