{"_id":"55e4d19fe252ac0d00303a73","version":{"_id":"54da5d305b80b62300dadc51","project":"54da5d2f5b80b62300dadc4e","__v":7,"createdAt":"2015-02-10T19:34:08.062Z","releaseDate":"2015-02-10T19:34:08.062Z","categories":["54da5d305b80b62300dadc52","54da704b11dfeb1900430309","54da705c44b1090d00072b34","54db48c86db3861700c840c5","54db48cd7dadb32300511364","54dbaa0c7dadb3230051143b","572b89f0b352ab0e003daca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1.0","version_clean":"1.0.0","version":"1"},"category":{"_id":"54db48c86db3861700c840c5","__v":13,"version":"54da5d305b80b62300dadc51","pages":["54db4c2c7dadb3230051136b","54db4f1c74dfff3700f161d9","54db53fdeb78f13900cf108e","54db65ec1a14312100313971","54dbad189f8ef11900f4df66","54dbccb800add623007578b4","54ff74002882a10d00546966","55de2abb9067202b00ddfffb","55e4d19fe252ac0d00303a73","5654c2d82308e12b00a14add","56980f9c080e0c0d00a835dc","569810e0895fd40d00d4b2f8","56e30b3051857d0e008e77a1"],"project":"54da5d2f5b80b62300dadc4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-11T12:19:20.398Z","from_sync":false,"order":0,"slug":"rest-api","title":"Rest API"},"githubsync":"","parentDoc":null,"project":"54da5d2f5b80b62300dadc4e","__v":14,"user":"54da5cb85b80b62300dadc4b","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-31T22:13:51.559Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \\n\\nEsta documentação é referente à API da plataforma Clicksign Classic.\",\n  \"title\": \"Utilize a nova plataforma de assinatura\"\n}\n[/block]\nÉ possível cancelar um documento que ainda não tenha sido completamente assinado, ou seja, se a lista de assinaturas possuir algum signatário pendente de assinatura, o documento poderá ser cancelado pelo seu criador.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atenção:\",\n  \"body\": \"Quando o documento for cancelado, todos os signatários que já tiverem assinado o documento receberão automaticamente uma notificação por e-mail informando o seu cancelamento.\"\n}\n[/block]\n### Requisição\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"0-1\": \"`POST`\",\n    \"1-0\": \"Path\",\n    \"1-1\": \"`/v1/documents/:key/cancel?access_token=string`\",\n    \"2-1\": \"`Content-Type: application/json`\\n\\n`Accept: application/json`\",\n    \"2-0\": \"Headers\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n#### Resposta:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 200 OK\\nContent-Type:application/json\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"document\\\": {\\n    \\\"key\\\": \\\"6abc84b4-1f42-4b2f-8f87-334b040e7b30\\\",\\n    \\\"original_name\\\": \\\"Documento Word.docx\\\",\\n    \\\"status\\\": \\\"canceled\\\",\\n    \\\"created_at\\\": \\\"2015-01-30T14:46:14.984-02:00\\\",\\n    \\\"updated_at\\\": \\\"2015-01-30T14:46:14.984-02:00\\\",\\n    \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n    \\\"list\\\": {\\n      \\\"started_at\\\": \\\"2015-02-12T13:50:02.727-02:00\\\",\\n      \\\"created_at\\\": \\\"2015-01-30T14:46:14.981-02:00\\\",\\n      \\\"updated_at\\\": \\\"2015-02-12T13:50:02.728-02:00\\\",\\n      \\\"canceled_at\\\": \\\"2015-02-13T13:50:02.728-02:00\\\",\\n      \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n      \\\"signatures\\\": [\\n        {\\n          \\\"display_name\\\": \\\"Willy Wonka\\\",\\n          \\\"title\\\": \\\"Diretor\\\",\\n          \\\"company_name\\\": \\\"Fabrica de Chocolates S.A.\\\",\\n          \\\"documentation\\\": \\\"123.321.123-40\\\",\\n          \\\"key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": \\\"agreed\\\",\\n          \\\"address\\\": \\\"123.321.153.155\\\",\\n          \\\"email\\\": \\\"willy.wonka:::at:::chocolates.com\\\",\\n          \\\"signed_at\\\": \\\"2015-02-12T13:50:09.479-02:00\\\",\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-02-12T13:49:50.834-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-02-12T13:50:09.504-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        },\\n        {\\n          \\\"display_name\\\": \\\"charlie@bucket.com\\\",\\n          \\\"title\\\": null,\\n          \\\"company_name\\\": null,\\n          \\\"documentation\\\": null,\\n          \\\"key\\\": null,\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": null,\\n          \\\"address\\\": null,\\n          \\\"email\\\": \\\"charlie@bucket.com\\\",\\n          \\\"signed_at\\\": null,\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-02-12T13:49:58.309-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-02-12T13:49:58.309-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        }\\n      ]\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"cancelamento","type":"basic","title":"Cancelamento"}
[block:callout] { "type": "danger", "body": "Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \n\nEsta documentação é referente à API da plataforma Clicksign Classic.", "title": "Utilize a nova plataforma de assinatura" } [/block] É possível cancelar um documento que ainda não tenha sido completamente assinado, ou seja, se a lista de assinaturas possuir algum signatário pendente de assinatura, o documento poderá ser cancelado pelo seu criador. [block:callout] { "type": "warning", "title": "Atenção:", "body": "Quando o documento for cancelado, todos os signatários que já tiverem assinado o documento receberão automaticamente uma notificação por e-mail informando o seu cancelamento." } [/block] ### Requisição [block:parameters] { "data": { "0-0": "Method", "0-1": "`POST`", "1-0": "Path", "1-1": "`/v1/documents/:key/cancel?access_token=string`", "2-1": "`Content-Type: application/json`\n\n`Accept: application/json`", "2-0": "Headers" }, "cols": 2, "rows": 3 } [/block] #### Resposta: [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\nContent-Type:application/json", "language": "http" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"document\": {\n \"key\": \"6abc84b4-1f42-4b2f-8f87-334b040e7b30\",\n \"original_name\": \"Documento Word.docx\",\n \"status\": \"canceled\",\n \"created_at\": \"2015-01-30T14:46:14.984-02:00\",\n \"updated_at\": \"2015-01-30T14:46:14.984-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"list\": {\n \"started_at\": \"2015-02-12T13:50:02.727-02:00\",\n \"created_at\": \"2015-01-30T14:46:14.981-02:00\",\n \"updated_at\": \"2015-02-12T13:50:02.728-02:00\",\n \"canceled_at\": \"2015-02-13T13:50:02.728-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"signatures\": [\n {\n \"display_name\": \"Willy Wonka\",\n \"title\": \"Diretor\",\n \"company_name\": \"Fabrica de Chocolates S.A.\",\n \"documentation\": \"123.321.123-40\",\n \"key\": \"A11D-EBAD-1D86-B7B4\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"123.321.153.155\",\n \"email\": \"willy.wonka@chocolates.com\",\n \"signed_at\": \"2015-02-12T13:50:09.479-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-02-12T13:49:50.834-02:00\",\n \"updated_at\": \"2015-02-12T13:50:09.504-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n },\n {\n \"display_name\": \"charlie@bucket.com\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": null,\n \"key\": null,\n \"act\": \"sign\",\n \"decision\": null,\n \"address\": null,\n \"email\": \"charlie@bucket.com\",\n \"signed_at\": null,\n \"allow_method\": \"token\",\n \"created_at\": \"2015-02-12T13:49:58.309-02:00\",\n \"updated_at\": \"2015-02-12T13:49:58.309-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n }\n ]\n }\n }\n}", "language": "json", "name": "Body" } ] } [/block]