POST
/
delete_files
curl --request POST \
  --url https://api.carbon.ai/delete_files \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "file_ids": [
    123
  ],
  "sync_statuses": [
    "DELAYED"
  ],
  "delete_non_synced_only": true,
  "send_webhook": true,
  "delete_child_files": true
}'
{
  "success": true
}

Authorizations

authorization
string
headerrequired

token <token>, corresponds to temporary access tokens.

Body

application/json
file_ids
integer[] | null
sync_statuses
enum<string>[] | null
Available options:
DELAYED,
QUEUED_FOR_SYNC,
SYNCING,
READY,
SYNC_ERROR,
EVALUATING_RESYNC,
RATE_LIMITED,
SYNC_ABORTED,
QUEUED_FOR_OCR
delete_non_synced_only
boolean
default: false
send_webhook
boolean
default: false
delete_child_files
boolean
default: false

Response

200 - application/json
success
boolean
required