API reference › Notifications › Module event trigger notifications
Update module event trigger notification
PUT /v1/settings/module-event-trigger-notifications/{module_name}
- Scope
settings_notifications_preferences:edit- Roles
- admin, scheduler
Updates a specific module event trigger notification. Supports partial updates - only provided fields will be updated.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
module_name required | string | Module name Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Module event trigger notification data (partial updates supported)
| Field | Type | Description |
|---|---|---|
triggerName | string | Trigger name (required) Example |
inApp | boolean | In-app notification (optional) Example |
email | boolean | Email notification (optional) Example |
sms | boolean | SMS notification (optional) Example |
Example
{
"triggerName": "assignment_created",
"inApp": false,
"email": true,
"sms": false
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/settings/module-event-trigger-notifications/{module_name}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"triggerName":"assignment_created","inApp":false,"email":true,"sms":false}'Try it
Responses
200 Successful update
Successful update
{
"success": true,
"message": "Module event trigger notification 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 |
404 Not found
Module event trigger notification not found
{
"success": false,
"message": "Module event trigger notification not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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: |