Skip to main content

Xóa hồ sơ

Endpoint

MethodURL
POSThttps://tpa.docbase.ai/api/v1/integrations/folders/{FolderID}/submissions/delete

Params

Tham sốCác giá trị đầu vàoMô tả
delete_file"true" hoặc "false"Nếu là "true" thì sẽ xóa file gốc của hồ sơ, "false" thì sẽ không xóa
delete_thumb"true" hoặc "false"Nếu là "true" thì sẽ xóa file ảnh từng trang của hồ sơ, "false" thì sẽ không xóa

Authorization

Auth Type: Basic Auth

Username: api_key của thư mục chứa hồ sơ

Body

Tham sốKiểu dữ liệuMô tả
submission_idsarray[integer]ID của các hồ sơ cần xóa (ví dụ: [1,3,6,36])

Ví dụ

MethodURL
POSThttps://tpa.docbase.ai/api/v1/integrations/folders/1/submissions/delete

Mô tả Trả về thông tin của bộ hồ sơ nào xóa thành công và bộ nào xóa thất bại.

Response 200

{
"deleted_ids": [],
"error_ids": []
}
Tên trườngKiểu dữ liệuMô tả
deleted_idslistDanh sách id của hồ sơ đã xóa thành công
error_idslistDanh sách id của hồ sơ xóa không thành công