Skip to main content
PUT
https://suasofia.online/api/
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
/
{documentId}
Atualizar documento
curl --request PUT \
  --url https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "message": "Documento atualizado com sucesso.",
  "data": {
    "id": 1,
    "name": "Manual do Produto Atualizado",
    "description": "Guia do usuário revisado com novas funcionalidades",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Ativo",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}
Este endpoint atualiza os metadados de um documento existente. Você só pode atualizar o nome e a descrição - o tipo e conteúdo do documento não podem ser alterados.

Parâmetros do Caminho

knowledgebaseId
integer
required
O identificador único da base de conhecimento
documentId
integer
required
O identificador único do documento a ser atualizado

Corpo da Requisição

name
string
O novo nome para o documento (máx. 255 caracteres)
description
string
A nova descrição para o documento (máx. 255 caracteres)

Resposta

message
string
Mensagem de sucesso
data
object
O objeto documento atualizado
{
  "message": "Documento atualizado com sucesso.",
  "data": {
    "id": 1,
    "name": "Manual do Produto Atualizado",
    "description": "Guia do usuário revisado com novas funcionalidades",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Ativo",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}
Para atualizar o conteúdo de um documento, você precisa excluir o documento existente e criar um novo com o conteúdo atualizado.