API reference › Handshakes › Document settings

Remove a handshake document setting's attached file

DELETE /v1/handshake-document-settings/{handshake_document_setting}/document

Scope
settings_notifications_preferences:edit
Roles
admin, scheduler

Deletes the attached file and keeps the setting itself.

Parameters

Path parameters

NameTypeDescription
handshake_document_setting requiredinteger

Example 4.

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

Example request

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

Try it

Responses

200 File removed; returns the updated setting

File removed; returns the updated setting.

JSON
{
  "success": true,
  "message": "Document removed.",
  "data": {
    "id": 4,
    "documentName": "NDA Agreement",
    "isRequired": true,
    "documentUrl": "string",
    "temporaryUrl": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
Response fields (10)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Document removed..

dataobject
data.idinteger

Example 4.

data.documentNamestring

Example NDA Agreement.

data.isRequiredboolean

Example true.

data.documentUrlstring or null

Short-lived download link for the attached file, or null when none is attached. Empty outside production.

data.temporaryUrlstring or null

The same link as documentUrl.

data.createdAtstring (date-time) or null
data.updatedAtstring (date-time) or null
400 Bad request

No such setting, or it has no attached file.

JSON
{
  "success": false,
  "message": "The request could not be processed.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The request could not be processed..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

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 .

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": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .