> For the complete documentation index, see [llms.txt](https://devcenter.unico.io/unico-sign/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devcenter.unico.io/unico-sign/guia-das-apis/gerenciando-envelopes/cancelar-envelopes.md).

# Cancelar envelopes

## Sobre este guia[​](https://developers.unico.io/docs/sign/api-guides/managing-evelopes/cancel-evelope#sobre-este-guia) <a href="#sobre-este-guia" id="sobre-este-guia"></a>

Através deste guia, demonstraremos como cancelar um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de cancelar um envelope a partir de seu UUID e receber uma confirmação em uma resposta JSON.

## O que você vai precisar[​](https://developers.unico.io/docs/sign/api-guides/managing-evelopes/cancel-evelope#o-que-voc%C3%AA-vai-precisar) <a href="#o-que-voce-vai-precisar" id="o-que-voce-vai-precisar"></a>

Antes de iniciar sua integração:

1. Certifique-se que você possui credenciais válidas para utilizar o **Unico Sign**. Se você ainda não possui suas credenciais, siga nosso [<mark style="color:blue;">guia de Primeiros Passos</mark>](https://devcenter.unico.io/unico-sign/primeiros-passos) para configurar sua conta de teste e obter suas chaves de API.
2. Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do **Unico Sign**. Você pode encontrar nossos conceitos básicos [<mark style="color:blue;">neste guia</mark>](https://devcenter.unico.io/unico-sign/conceitos-basicos).

## Funcionamento básico[​](https://developers.unico.io/docs/sign/api-guides/managing-evelopes/cancel-evelope#funcionamento-b%C3%A1sico) <a href="#funcionamento-basico" id="funcionamento-basico"></a>

Como explicamos em nosso [<mark style="color:blue;">guia de conceitos básicos</mark>](https://devcenter.unico.io/unico-sign/conceitos-basicos), nossa entidade **Envelope** (`envelope`) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (`document`) e seus assinantes (`subscriber`), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.

Ao cancelar um envelope, um e-mail e/ou SMS serão enviados para os assinantes dos documentos contidos no envelope. O método de notificação irá dependender de quais dados dos assinantes foram cadastrados no momento do envio do envelope.

Uma vez cancelado, o envelope não poderá mais ser acessado, assinado ou recusado pelos assinantes.

Entenda, a seguir, como chamar nossa API REST para cancelar um envelope.

{% stepper %}
{% step %}

### Obtenha um token OAuth válido <a href="#obtenha-um-token-oauth-valido" id="obtenha-um-token-oauth-valido"></a>

Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido [<mark style="color:blue;">neste artigo</mark>](https://devcenter.unico.io/unico-sign/guia-das-apis/autenticacao).  Após sua geração, o token de acesso deverá ser enviado no `header` de sua requisição,  junto ao parâmetro `Authorization`.

{% hint style="info" %}
**Ambientes**

Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.

Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:

* Ambiente de homologação: `https://signhom.acesso.io`;
* Ambiente de produção: `https://sign.acesso.io`.
  {% endhint %}

{% endstep %}

{% step %}

### Faça uma requisição POST para o endpoint `/cancel/` <a href="#faca-uma-requisicao-post-para-o-endpoint-cancel" id="faca-uma-requisicao-post-para-o-endpoint-cancel"></a>

Após gerar um token de acesso válido, faça uma requisição para o endpoint de cancelamento de envelopes da nossa API REST (POST/service/cancel) enviando os parâmetros conforme o schema abaixo:

<table data-header-hidden><thead><tr><th>Parâmetro</th><th width="161">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>EnvelopeUUID</td><td>string &#x3C;uuid></td><td>Identificador único do envelope</td></tr><tr><td>Reason</td><td>string</td><td>Motivo de cancelamento do envelope</td></tr><tr><td>UserName</td><td>string or null</td><td><p>Default: <code>"Integração"</code></p><p></p><p>Nome do usuário que está cancelando</p><p>Se não fornecido será extraído o nome de usuário do token utilizado, e se não encontrado o nome será <code>Integração</code></p></td></tr></tbody></table>

{% hint style="warning" %}
**Permissão para Visualizar Documentos**

Para utilizar esta rota é necessário que o usuário tenha permissão de **Enviar Documentos.**
{% endhint %}

Abaixo um exemplo de como cancelar um envelope com o UUID igual a **00000000-0000-0000-0000-000000000000** informando como motivo "**Solicitação de correção**":

```json

curl -X 'POST' \
  'https://signhom.acesso.io/api/v1/service/cancel' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}'
  -d '{
  "EnvelopeUUID": "00000000-0000-0000-0000-000000000000",
  "Reason": "Solicitação de correção"
}'
```

Se tudo der certo em sua requisição, você receberá como resposta um JSON contendo a confirmação da exclusão do envelope.

```json
{
  "Success": true,
  "Message": "Envelope cancelado com sucesso"
}
```

{% endstep %}
{% endstepper %}

## Próximos passos[​](https://developers.unico.io/docs/sign/fundamentals#pr%C3%B3ximos-passos) <a href="#proximos-passos" id="proximos-passos"></a>

* Conheça as funcionalidades disponíveis para o [<mark style="color:blue;">Gerenciamento de documentos</mark>](https://devcenter.unico.io/unico-sign/guia-das-apis/gerenciando-documentos).
* Conheça as funcionalidades disponíveis para o [<mark style="color:blue;">Gerenciamento de envelopes</mark>](https://devcenter.unico.io/unico-sign/guia-das-apis/gerenciando-envelopes).
* Tendo problemas em nossa integração? Acesse nossa seção de [<mark style="color:blue;">FAQ e problemas comuns</mark>](https://devcenter.unico.io/unico-sign/recursos-adicionais/faq).

***

**Dúvidas?**[**​**](https://developers.unico.io/docs/IDunico/Integracao/primeirosPassos#d%C3%BAvidas)

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da [<mark style="color:blue;">Central de Ajuda</mark>](https://empresas.unico.io/hc/pt-br/p/atendimentoparaempresas).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://devcenter.unico.io/unico-sign/guia-das-apis/gerenciando-envelopes/cancelar-envelopes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.