📘
Requisição para alteração das configurações dos documentos na Clicksign. Essa é uma requisição PATCH para /documents/:key, sendo :key a chave do documento na Clicksign. No body, deverão ser enviados os atributos listados abaixo.

PATCH /api/v1/documents/:key?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Atributos da requisição

Atributo	Descrição	Exemplo
`deadline_at`	Data limite para a realização das assinaturas no documento. Documento será finalizado automaticamente quando a data limite for atingida. Se houver assinaturas, o Documento ficará com o status finalizado, caso contrário, o documento será cancelado. Data limite máxima é de 90 dias contados a partir do upload. Valor padrão é de 30 dias contados a partir do upload. Uma vez cancelado, o processo não pode ser retomado. O valor deve ser maior que a data/hora atual.	2018-06-28T14:30:59-03:00
`auto_close`	Determina se o documento será finalizado automaticamente logo após a assinatura do último signatário. Valor padrão é `true`.	true
`locale`	Determina o idioma do documento. Os e-mails, página de assinatura e Log do documento assinado estarão no idioma definido. Idiomas suportados: `pt-BR` `en-US` Valor padrão é `pt-BR`.	pt-BR
`sequence_enabled`	Determina se o documento terá a funcionalidade de ordenação de assinaturas ativada. Valor padrão é `false`	false
`remind_interval`	Determina se o documento terá opção de lembretes automáticos ativada. O intervalo é medido em dias. Com a inclusão do parâmetro serão enviados até três lembretes automaticamente . Intervalos suportados: `1` `2` `3` `7` `14` Valor padrão é a desabilitação da funcionalidade.	3
`block_after_refusal`	Determina se o processo de assinatura tem que ser pausado ou não após um signatário ter recusado. Valor padrão é `true` e os valores disponíveis são `true` ou `false`.	true

❗️
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/v1/documents/c0e4796b-a342-43ef-b682-e4985d822e05?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
  "auto_close": false,
  "deadline_at": "2018-09-20T02:59:00.000Z",
  "locale": "pt-BR",
}

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "document": {
    "key": "c0e4796b-a342-43ef-b682-e4985d822e05",
    "path": "/Contrato de Prestação de Serviços-123.pdf",
    "filename": "Contrato de Prestação de Serviços-123.pdf",
    "uploaded_at": "2018-06-24T14:15:57.630Z",
    "updated_at": "2018-06-24T15:12:46.617Z",
    "finished_at": null,
    "deadline_at": "2018-09-20T02:59:00.000Z",
    "status": "running",
    "auto_close": false,
    "locale":"pt-BR",
    "sequence_enabled": false,
	  "remind_interval": 3,
    "block_after_refusal": true,
    "downloads": {
      "original_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/24/14/15/57/12404274-1456-4d2e-8b74-524a5738ef45/file.pdf?X-Amz-Expires=301&X-Amz-Date=20180624T151245Z&X-Amz-Security-Token=FQoDYXdzEHgaDFb02AT6PI1Gvn00tSK3A9FRbmcOCPAGdDocp0MYsywqRRdzcYczFWnj7LKw3jNqIV90ec2E7Ild0nr1tK12ev4i6U6xmNuGJ8kjTOl9TTBtL3vVCGH8w29ls64a/sruWEAFBs56jCb429L3HdwpLfodMx6IEoKZuWI0sds3VB%2BJmBgozDaF2dghBdhOG5TYnkrrl4%2BWgnWQnWu0v11xz7wRgIargndt/NJaspMdDK6o3bnkwiXojyoiEF20FEh4nz3KVRorA5EJOQWuGrqUhECpKZ6YlEEyqiCtv7eB6jQWRMKbjKQMvDd9Ue4NyNnOi%2Bvq8lJYV8V6H%2B55Qvy5e%2Bikimu2SGDBfdvTUnvgZ%2BpM%2B5rFf%2BcfWu0DVop%2BrWTpAxUp9YNERK1FYK3IgTgfijGspwmpQfKvYkvutSv2f4CuoGeBWZqm9g/H8OPkXYnCFGJK2VJPbrljDV9b4R5/H%2BGW3cQG8iTvY8jM2/ye441VW0iPYeNOSf4h59f5xgtZuMIbmNAmMKtbY13%2B1IN8BX11Jjd9kGtsHf%2BiPvIPyfwDirG%2BkEDKv1uCKKmy7dgXRs/5NXV4hWsAOeNOuK155S4BRdI41%2BgopdW%2B2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIII64FD6IG5DOEJQ/20180624/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=9b2d93c9fcad5931aec5c84a2900f9ebcd5b0b94ca9fb26cf37ca8288d9d3229"
    },
    "signers": [],
    "events": [
      {
        "name": "update_auto_close",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "auto_close": false
        },
        "occurred_at": "2018-06-24T15:12:46.630Z"
      },
      {
        "name": "update_deadline",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "deadline_at": "2018-09-19T23:59:00.000-03:00"
        },
        "occurred_at": "2018-06-24T15:12:46.586Z"
      },
      {
        "name": "upload",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "deadline_at": "2018-06-28T14:30:59.000-03:00",
          "auto_close": true,
          "locale": "pt-BR"
        },
        "occurred_at": "2018-06-24T14:15:57.691Z"
      }
    ]
  }
}