API reference › Restricted lists › Restricted list
Update a block list entry
PATCH /v1/settings/portal/block-list/{block_list}
- Scope
settings_restricted_users:edit- Roles
- client, consumer, service-provider
Partially update a block list entry. Supports updating the 'blockedBy', 'blockedUser', and 'notes' fields.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
block_list required | integer | ID of the block list entry to update Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
blockedUser | object or null | |
blockedUser.id | string | ID of the user being blocked Example |
blockedUser.label | string | Label of the user being blocked Example |
notes | string or null | Optional notes Example |
isBehalfOfOrg | boolean or null | Record the entry on behalf of the organization rather than the caller. Defaults to false. Example |
Example
{
"blockedUser": {
"id": "CSM-5W5RVY",
"label": "Consumer"
},
"notes": "Updated reason for blocking",
"isBehalfOfOrg": false
}Example request
curl -X PATCH "https://api.fetchfido.ai/v1/settings/portal/block-list/{block_list}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"blockedUser":{"id":"CSM-5W5RVY","label":"Consumer"},"notes":"Updated reason for blocking","isBehalfOfOrg":false}'Try it
Responses
200 Successfully updated block list entry
Successfully updated block list entry
{
"success": true,
"message": "Block List updated successfully."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
400 Bad request
Validation error
{
"success": false,
"message": "Failed to update."
}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_restricted_users: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
Block List entry not found
{
"success": false,
"message": "Blocked user entry 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: |
500 Server error
Internal Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Block list update failed: [error details]."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |