API reference › Restricted lists › Restricted list

Delete a block list entry

DELETE /v1/settings/portal/block-list/{block_list}

Scope
settings_restricted_users:delete
Roles
client, consumer, service-provider

Deletes a block list entry by its ID. If the ID does not exist, a 404 error will be returned.

Parameters

Path parameters

NameTypeDescription
block_list requiredinteger

The ID of the block list entry to delete

Example 2.

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

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/settings/portal/block-list/{block_list}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Deleted successfully

Deleted successfully

JSON
{
  "success": true,
  "message": "Block List entry deleted successfully."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Block List entry deleted 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_restricted_users:delete' 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_restricted_users:delete' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Entry not found

JSON
{
  "success": false,
  "message": "Block List entry not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Block List entry not found..

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.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected server error occurred."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Unexpected server error occurred..