Update document

This endpoint allows you to update the information of a document as long as it is still in progress (i.e., it has not been completed or canceled).

Update document

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

Conditions

  • The document must be in "in progress" status.

  • Only the fields listed below can be updated.

Path Parameters

Name
Type
Description

doc_token

string

Document token

Headers

Name
Type
Description

Authorization*

string

apiToken ahead of the "Bearer" text.

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

Body

Field
Type
Description

name

string

New name for the main document.

date_limit_to_sign

string (YYYY-MM-DD)

New deadline date to sign the document.

folder_path

string

Folder path to organize the document within your account.

folder_token

string

If provided, this field will take precedence over folder_path. It defines the directory based on the folder token, which can be obtained by accessing: https://app.zapsign.com.br/conta/documentos?pasta=<folder_token>

If you don't know the token yet, navigate to the desired folder starting from: https://app.zapsign.com.br/conta/documentos Then, copy the pasta parameter from the URL after opening the target folder.

extra_docs

array of objects

List of associated extra documents that can be renamed.

Structure of extra_docs

Field
Type
Description

token

string

Token of the previously uploaded extra document.

name

string

New name for that extra document.

Body

{
  "name": "Contrato de Servicios 2026",
  "date_limit_to_sign": "2025-06-26",
  "folder_path": "/Contratos/2026/Enero/",
  "extra_docs": [
    {
      "token": "token_del_documento_extra",
      "name": "Nuevo nombre documento extra"
    }
  ]
}
{
    "message": "Document successfully updated"
}

Last updated

Was this helpful?