API reference › Assignments

Delete assignment files by file IDs

DELETE /v1/assignment/document/files

Scope
assignments:edit
Roles
admin, scheduler

Parameters

None of its own.

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

Request body required

FieldTypeDescription
fileIdsarray of integer

File IDs to delete. Missing, empty, or not an array is treated as no IDs given — see the 200 response.

Example

JSON
{
  "fileIds": [
    101,
    102
  ]
}

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/assignment/document/files" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"fileIds":[101,102]}'

Try it

Responses

200 Request processed — never rejected for missing/empty/malformed fileIds

Request processed — never rejected for missing/empty/malformed fileIds. A fileId that doesn't resolve to a real document is skipped rather than failing the request; if none of the given IDs resolved (including when fileIds was missing or empty), the message reports that nothing was deleted instead of a file count.

JSON
{
  "success": true,
  "message": "All files were deleted successfully."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example All files were 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 'assignments: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 'assignments:edit' 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

Unexpected error

JSON
{
  "success": false,
  "errors": "Assignment files deletion failed",
  "message": "An unexpected error occurred — please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

errorsstring or null

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

Example Assignment files deletion failed.

messagestring

Example An unexpected error occurred — please try again..