Update document

Este endpoint permite atualizar os dados de um documento desde que ele ainda esteja em andamento (ou seja, que não tenha sido finalizado nem cancelado).

Atualizar documento

PUT https://api.zapsign.com.br/api/v1/docs/{{doc_token}}/

Condições

  • O documento deve estar no estado "em andamento".

  • Somente os campos indicados abaixo podem ser modificados.

Path Parameters

Name
Type
Description

doc_token

string

Token do documento

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Body

Campo
Tipo
Descrição

name

string

Novo nome do documento principal.

date_limit_to_sign

string (YYYY-MM-DD)

Nova data limite para assinatura do documento.

folder_path

string

Caminho da pasta onde o documento será organizado na sua conta.

folder_token

string

Se preenchido, este campo terá prioridade sobre folder_path. Ele define o diretório com base no token da pasta, que pode ser obtido acessando o seguinte endereço: https://app.zapsign.com.br/conta/documentos?pasta=<token_da_pasta>

Se você ainda não souber o token, navegue até a pasta desejada a partir de: https://app.zapsign.com.br/conta/documentos e copie o valor do parâmetro pasta na URL após acessar a pasta.

extra_docs

array de objetos

Lista de documentos extras vinculados que podem ser renomeados.

Estrutura extra_docs

Campo
Tipo
Descrição

token

string

Token do documento extra já enviado anteriormente.

name

string

Novo nome para esse documento extra.

Exemplo body

{
  "name": "Contrato de Serviços 2026",
  "date_limit_to_sign": "2025-06-26",
  "folder_path": "/Contratos/2026/Janeiro/",
  "extra_docs": [
    {
      "token": "token_do_documento_extra",
      "name": "Novo nome do documento extra"
    }
  ]
}
{
    "message": "Documento atualizado corretamente"

}

Last updated

Was this helpful?