API reference › General settings › Requirements and preferences

Delete a Requirement and Preference entry

DELETE /v1/settings/delete-requirements/{id}

Scope
settings_general:delete
Roles
admin, scheduler

Deletes a specific requirement and preference record based on the given ID.

Parameters

Path parameters

NameTypeDescription
id requiredinteger

ID of the requirement_and_preference to delete

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

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/settings/delete-requirements/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Requirement and preference deleted successfully

Requirement and preference deleted successfully.

JSON
{
  "success": true,
  "message": "Requirement and preference deleted successfully.",
  "data": "Deleted"
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Requirement and preference deleted successfully..

datastring

Example Deleted.

400 Bad request

Invalid ID or deletion failed.

JSON
{
  "success": false,
  "message": "Failed to delete.",
  "errors": "InvalidArgumentException message"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to delete..

errorsstring

Example InvalidArgumentException message.

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_general: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_general:delete' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

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

Server error occurred.

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Server error details"
}
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 Server error details.