API reference › Notifications › Default access setting
Update default access setting
PUT /v1/settings/default-access-setting/{id}
- Scope
settings_notifications_preferences:edit- Roles
- admin, scheduler
Updates a specific default access setting. Supports partial updates - only provided fields will be updated.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | integer | Default access setting ID Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Default access setting data (partial updates supported)
| Field | Type | Description |
|---|---|---|
roleId | integer | Role ID (optional) Example |
portalAccess | boolean | Portal access (optional) Example |
networkEnabled | boolean | Network enabled (optional) Example |
shareWithinOrganization | boolean | Share within organization (optional) Example |
createAssignmentRequest | boolean | Create assignment request (optional) Example |
viewManageFinances | boolean | View manage finances (optional) Example |
createAssignment | boolean | Create assignment (optional) Example |
Example
{
"roleId": 1,
"portalAccess": true,
"networkEnabled": false,
"shareWithinOrganization": true,
"createAssignmentRequest": false,
"viewManageFinances": true,
"createAssignment": false
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/settings/default-access-setting/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"roleId":1,"portalAccess":true,"networkEnabled":false,"shareWithinOrganization":true,"createAssignmentRequest":false,"viewManageFinances":true,"createAssignment":false}'Try it
Responses
200 Successful update
Successful update
{
"success": true,
"message": "Default access setting 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
Default access setting not found
{
"success": false,
"message": "Default access setting not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
422 Validation failed
Validation error
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"roleId": [
"The roleId must be an integer."
],
"portalAccess": [
"The portalAccess field must be true or false."
],
"networkEnabled": [
"The networkEnabled field must be true or false."
],
"shareWithinOrganization": [
"The shareWithinOrganization field must be true or false."
],
"createAssignmentRequest": [
"The createAssignmentRequest field must be true or false."
],
"viewManageFinances": [
"The viewManageFinances field must be true or false."
],
"createAssignment": [
"The createAssignment field must be true or false."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
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: |