Cancelar documento

📘
Requisição para cancelamento dos documentos na Clicksign. Após o cancelamento do documento, não poderão ser realizadas novas assinaturas. Essa é uma requisição PATCH para /documents/:key/cancel, sendo :key a chave do documento na Clicksign.

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

❗️
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/e612b2ac-f3c7-4988-8556-a98665a438d5/cancel?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

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

{
  "document": {
    "key": "e612b2ac-f3c7-4988-8556-a98665a438d5",
    "path": "/Contrato de Prestação de Serviços-123.pdf",
    "filename": "Contrato de Prestação de Serviços-123.pdf",
    "uploaded_at": "2018-06-24T15:21:26.585Z",
    "updated_at": "2018-06-24T15:21:55.423Z",
    "finished_at": "2018-06-24T15:21:55.269Z",
    "deadline_at": "2018-06-28T17:30:59.000Z",
    "status": "canceled",
    "auto_close": true,
    "locale": "pt-BR",
    "block_after_refusal": true,
    "downloads": {
      "original_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/24/15/21/26/3cb73d97-ae6d-48b0-a44e-63d350441d6b/file.pdf?X-Amz-Expires=301&X-Amz-Date=20180624T152154Z&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=00fa81d29ca1695822b4a7e80300468bacf89b95dd5cc8eb1d540b63e7b25060"
    },
    "signers": [
      {
        "key": "aa65fcdb-c6ed-47c6-b32f-9e0dc337528e",
        "email": "[email protected]",
        "name": "Marcos Zumba",
        "has_documentation": true,
        "documentation": "123.321.123-40",
        "birthday": "1983-03-31",
        "phone_number": "11999999999",
        "sign_as": "sign",
        "url": "https://sandbox.clicksign.com/sign/aa65fcdb-c6ed-47c6-b32f-9e0dc337528e",
        "auths": [
          "email"
        ],
        "created_at": "2018-06-24T15:21:26.594Z"
      }
    ],
    "events": [
      {
        "name": "cancel",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          }
        },
        "occurred_at": "2018-06-24T15:21:55.437Z"
      },
      {
        "name": "add_signer",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Ajuda Clicksign"
          },
          "account": {
            "key": "5552e2a8-895f-4f13-afa8-c405f5eb84e4"
          },
          "signers": [
            {
              "key": "aa65fcdb-c6ed-47c6-b32f-9e0dc337528e",
              "email": "[email protected]",
              "name": "Marcos Zumba",
              "birthday": "1983-03-31",
              "documentation": "123.321.123-40",
              "has_documentation": true,
              "created_at": "2018-06-24T12:21:26.594-03:00",
              "sign_as": "sign",
              "auths": [
                "email"
              ],
              "url": "https://sandbox.clicksign.com/sign/aa65fcdb-c6ed-47c6-b32f-9e0dc337528e"
            }
          ]
        },
        "occurred_at": "2018-06-24T15:21:26.646Z"
      },
      {
        "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",
          "block_after_refusal": true
        },
        "occurred_at": "2018-06-24T15:21:26.622Z"
      }
    ]
  }
}