Mover pasta para a lixeira

PATCH

/documents/folders/trash/{idFolder}

Move uma pasta para a lixeira. A pasta é marcada como excluída e deixa de aparecer na listagem de documentos do cliente e no conteúdo da pasta de cima; o registro não é apagado. Informe no corpo, em trashingUser, o id, o nome e o e-mail do usuário que está fazendo a exclusão; esses dados ficam gravados na pasta. O corpo com trashingUser é obrigatório: sem ele a resposta é 500. id, name ou email ausentes dentro de trashingUser devolvem 422 com a lista de erros. Quando o id não corresponde a nenhuma pasta, a resposta é 200 com a mensagem Pasta não encontrada. 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

Pasta movida para a lixeira, ou pasta não encontrada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠422Dados inválidos

🔴500Falha ao mover a pasta para a lixeira

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Sucesso

{
    "message": "Pasta deletada com sucesso!"
}

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

Página anterior

Mover pasta

Próxima página

Listar documentos de um cliente