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
| Field | Type | Description |
|---|---|---|
deliveryInApp | boolean or null | Enable in-app notifications for delivery Example |
deliveryEmail | boolean or null | Enable email notifications for delivery Example |
deliverySms | boolean or null | Enable SMS notifications for delivery Example |
reminderInApp | boolean or null | Enable in-app notifications for reminders Example |
reminderEmail | boolean or null | Enable email notifications for reminders Example |
reminderSms | boolean or null | Enable SMS notifications for reminders Example |
summaryTime | string or null | Time for daily summary (HH:MM:SS format) Example |
leadInApp | boolean or null | Enable in-app notifications for leads Example |
leadEmail | boolean or null | Enable email notifications for leads Example |
leadSms | boolean or null | Enable SMS notifications for leads Example |
leadTime | integer 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 |
leadUnit | string or null | Required with leadTime. One of: |
dailySummaryEnabled | boolean or null | Turns on the daily summary. summaryTime is then required if a reminder channel is on. Example |
dailySummaryRecipients | array of string or null | Required, with at least one item, when dailySummaryEnabled is true. |
weeklySummaryEnabled | boolean or null | Example |
weeklySummaryTime | string or null | HH:MM:SS Example |
weeklySummaryDay | string or null | Required when weeklySummaryEnabled is true. One of: |
weeklySummaryRecipients | array of string or null | Required, with at least one item, when weeklySummaryEnabled is true. |
useSingleEmailAddress | boolean or null | Whether to use a single email address for all communications Example |
globalEmailAddress | string | Required when useSingleEmailAddress is true. Example |
Example
{
"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
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
{
"success": true,
"message": "Configuration updated successfully"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |