API reference › Notifications › Communication configuration
Store new communication configurations
POST /v1/settings/communication-configuration
- Scope
settings_notifications_preferences:write- Roles
- admin, scheduler
Creates multiple communication configurations for notification preferences
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Notification preferences configuration with modules and email
| Field | Type | Description |
|---|---|---|
module required | array of object | Array of module configurations |
module[].id | string | Module identifier Example |
module[].label | string | Module label/name Example |
email required | string | Email address for notifications Example |
Example
{
"module": [
{
"id": "assign",
"label": "Assignment"
},
{
"id": "shift",
"label": "Shift"
}
],
"email": "test@example.com"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/communication-configuration" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"module":[{"id":"assign","label":"Assignment"},{"id":"shift","label":"Shift"}],"email":"test@example.com"}'Try it
Responses
201 Successful creation
Successful creation
{
"success": true,
"message": "Communication configurations created 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:write' 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 |
422 Validation failed
Validation error
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"module": [
"The module field is required."
],
"email": [
"The email field is required."
],
"module.0.label": [
"The label field is required for each module."
]
}
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.module | array of string | |
errors.email | array of string | |
errors.module.0.label | array of string |
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: |