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

NameTypeDescription
id requiredinteger

Default access setting ID

Example 1.

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

Request body required

Default access setting data (partial updates supported)

FieldTypeDescription
roleIdinteger

Role ID (optional)

Example 1.

portalAccessboolean

Portal access (optional)

Example true.

networkEnabledboolean

Network enabled (optional)

Example false.

shareWithinOrganizationboolean

Share within organization (optional)

Example true.

createAssignmentRequestboolean

Create assignment request (optional)

Example false.

viewManageFinancesboolean

View manage finances (optional)

Example true.

createAssignmentboolean

Create assignment (optional)

Example false.

Example

JSON
{
  "roleId": 1,
  "portalAccess": true,
  "networkEnabled": false,
  "shareWithinOrganization": true,
  "createAssignmentRequest": false,
  "viewManageFinances": true,
  "createAssignment": false
}

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Default access setting updated successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Default access setting 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 .

404 Not found

Default access setting not found

JSON
{
  "success": false,
  "message": "Default access setting not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Default access setting not found..

422 Validation failed

Validation error

JSON
{
  "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)
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.