Mover arquivo para a lixeira

PATCH

/documents/files/trash/{idFile}

Move um arquivo para a lixeira do repositório de documentos. A exclusão é lógica: o arquivo deixa de aparecer na listagem de documentos do cliente, mas continua gravado e ainda pode ser consultado pelo identificador. Informe em trashingUser o identificador, o nome e o e-mail de quem está excluindo; esses dados são gravados como enviados, junto com a data e hora da exclusão. A resposta traz o arquivo atualizado. Arquivo inexistente devolve 400. Os três campos de trashingUser são obrigatórios e, se faltarem, a resposta é 422. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Arquivo movido para a lixeira

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠422Dados inválidos

🟠400Arquivo não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/documents/files/trash/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "trashingUser": {
        "id": "5f8d0d55b54764421b7156c9",
        "name": "Maria Exemplo",
        "email": "maria@example.com"
    }
}'

Response Example

200 - Sucesso

{
    "_id": "k5Qv8xYz2LmN9pRw3TbJ7cHd4FgA",
    "kind": "drive#file",
    "name": "Contrato social",
    "mimeType": "application/pdf",
    "description": "Contrato social consolidado",
    "trashed": true,
    "trashingUser": {
        "id": "5f8d0d55b54764421b7156c9",
        "name": "Maria Exemplo",
        "emailAddress": "maria@example.com",
        "trashedAt": "2026-09-14T13:20:00.000Z"
    },
    "parent": "root",
    "iconLink": null,
    "hasThumbnail": true,
    "thumbnailLink": null,
    "createdTime": "2026-09-01T10:00:00.000Z",
    "modifiedTime": null,
    "shared": false,
    "fileExtension": "pdf",
    "size": null,
    "fileUrl": "documentos/4005e4a6-08b5-4dea-b4f9-35a6630154ad/contrato-social.pdf",
    "labels": {
        "label": "Documentos Pessoais",
        "color": "#00C2E0",
        "companyId": "5f8d0d55b54764421b7156a1",
        "labels": []
    },
    "originalFilename": "contrato-social.pdf",
    "clientId": "4005e4a6-08b5-4dea-b4f9-35a6630154ad",
    "metadata": [],
    "createdAt": "2026-09-01T10:00:00.000Z",
    "updatedAt": "2026-09-14T13:20:00.000Z"
}

Modificado em 2026-10-13 09:47:06