📘
Requisição para alterar status de documento dentro de Envelope na Clicksign. Essa é uma requisição PATCH para /envelopes/[{envelopeid}]/documents/[{documentid}]. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

PATCH /api/v3/envelopes/{`{envelopeid}`} /documents/{`{documentid}`} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `documents`.	Sim
`id`	Número identificador do documento, disponível na resposta gerada ao criar o documento no Envelope.	Sim

Atributos do Envelope

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`status`	Altera o status de um documento para cancelado (usando o comando `canceled`) ou finalizado (usando o comando `closed`) quando o atributo `auto-close` foi configurado como `false` na criação do documento.	Sim	Sem valor padrão	canceled
`metadata`	Metadados do documento, os dados cadastrados serão enviados com o documento nos webhooks para facilitar a identificação deles pelo sistema que implementa a integração.	Não		`{ "variavel": "valor" }`

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

PATCH /api/v3/envelopes/{`{envelopeid}`} /documents/{`{documentid}`} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "data": {
    "type": "documents",
    "id":"3c3a1c23-ff98-40fd-8c87-a0064b25aedf",
    "attributes": {
      "status": "canceled",
      "metadata": { "minha_var": "novo valor" }
    }
  }
}

Response

HTTP/1.1 200 Ok
Content-Type: application/vnd.api+json; charset=utf-8

{
  "data": {
    "id": "3c3a1c23-ff98-40fd-8c87-a0064b25aedf",
    "type": "documents",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/documents/3c3a1c23-ff98-40fd-8c87-a0064b25aedf"
    },
    "attributes": {
      "filename": "DOCUMENTO.pdf",
      "status": "canceled",
      "template": null,
      "metadata": {
        "minha_var": "novo valor"
      },
      "created": "2024-09-09T12:17:07.308-03:00",
      "modified": "2024-09-09T12:17:07.633-03:00"
    }
  }
}