Reordenar documentos de um envelope

Este endpoint permite definir a ordem em que os documentos serão exibidos dentro de um envelope específico. É útil quando a ordem de leitura ou assinatura dos documentos é relevante.

Atualizar documento

PUT https://api.zapsign.com.br/api/v1/docs/{doc_token}/document-display-order/

Condições

  • O documento identificado por doc_token deve ser um envelope (ou seja, um documento que agrupa vários arquivos).

  • A reordenação só é permitida se o envelope estiver em andamento.

  • É necessário incluir todos os tokens dos documentos que compõem o envelope, na ordem desejada. Esses tokens estão disponíveis na resposta da criação do documento ou nos detalhes do envelope.

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

document_display_order

array de string

Lista ordenada de tokens dos documentos, indicando a nova ordem de exibição.

Exemplo body

{
  "document_display_order": [
    "6a4c7b7d-433e-4faf-a4b1-1f96bbf72c68",    
    "09d983a1-7c26-472a-a2ef-8ee10470b5ed",
    "9f8c63bb-eb1b-461d-8ede-0ae90d75c18a"
  ]
}

{
    "message": "Documento atualizado corretamente"

}

Last updated

Was this helpful?