Editar arquivo

PATCH

/documents/files/edit

Altera o nome de exibição, as etiquetas e os metadados de um arquivo do repositório de documentos. Informe no corpo o identificador do arquivo (id) e o novo nome (name), que são obrigatórios. labels e metadata são opcionais: quando enviados, substituem por inteiro os valores atuais, e quando omitidos, os valores atuais são mantidos. Cada item de metadata aceita apenas os campos name e value. O conteúdo, a pasta e o cliente do arquivo não mudam. A resposta traz o arquivo atualizado. Arquivo inexistente devolve 400, e erros de validação do corpo devolvem 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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Arquivo alterado

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/edit' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "id": "k5Qv8xYz2LmN9pRw3TbJ7cHd4FgA",
    "name": "Contrato social 2025",
    "metadata": [
        {
            "name": "Ano",
            "value": "2025"
        }
    ]
}'

Response Example

200 - Sucesso

{
    "name": "Contrato social 2025",
    "clientId": "4005e4a6-08b5-4dea-b4f9-35a6630154ad",
    "originalFilename": "contrato-social.pdf",
    "labels": {
        "label": "Documentos Pessoais",
        "color": "#00C2E0",
        "companyId": "5f8d0d55b54764421b7156a1",
        "labels": []
    },
    "fileExtension": "pdf",
    "parent": "root",
    "id": "k5Qv8xYz2LmN9pRw3TbJ7cHd4FgA",
    "mimeType": "application/pdf",
    "fileUrl": "documentos/4005e4a6-08b5-4dea-b4f9-35a6630154ad/contrato-social.pdf",
    "thumbnailLink": null,
    "kind": "drive#file",
    "metadata": [
        {
            "name": "Ano",
            "value": "2025"
        }
    ]
}

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

Página anterior

Mover arquivo para a lixeira

Próxima página

Mover arquivo