API reference › Notifications › Role event trigger notifications

Store or update role event trigger notification

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

Scope
settings_notifications_preferences:edit
Roles
admin, scheduler

Creates new notification or updates existing one based on role_id. Supports partial updates - only provided fields will be updated.

Parameters

None of its own.

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

Request body required

Single notification object - supports partial updates

FieldTypeDescription
roleIdinteger

Role ID (required)

Example 2.

inAppboolean

Enable in-app notifications (optional)

Example true.

emailboolean

Enable email notifications (optional)

Example false.

smsboolean

Enable SMS notifications (optional)

Example true.

canOverrideboolean

Whether the role can override (optional)

Example false.

Example

JSON
{
  "roleId": 2,
  "inApp": true,
  "email": false,
  "sms": true,
  "canOverride": false
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/role-event-trigger-notifications" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"roleId":2,"inApp":true,"email":false,"sms":true,"canOverride":false}'

Try it

Responses

200 Successful creation/update

Successful creation/update

JSON
{
  "success": true,
  "message": "Role event trigger notification updated successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Role event trigger notification 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 .

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "The given data was invalid.",
  "errors": {
    "roleId": [
      "The selected roleId is invalid."
    ],
    "inApp": [
      "The inApp field must be true or false."
    ],
    "email": [
      "The email field must be true or false."
    ],
    "sms": [
      "The sms field must be true or false."
    ],
    "canOverride": [
      "The canOverride field must be true or false."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The given data was invalid..

errorsobject
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.