📘
Requisição para ativar o Envelope criado. Essa é uma requisição PATCH para /envelopes/{{envelopeid}}. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

PATCH /api/v3/envelopes/{{envelopeid}} 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 `envelopes`.	Sim
`id`	Número identificador do envelope, disponível na resposta gerada ao criar o envelope.	Sim

Atributos de ativação do Envelope

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`status`	O status do envelope, que aqui deve ser `running` para ativá-lo.	Sim	Sem valor padrão	running
`name`	O nome do envelope.	Não		Teste
`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`	Não	pt-BR	pt-BR
`auto_close`	Determina se o documento será finalizado automaticamente logo após a assinatura do último signatário.	Não	true	true
`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`	Não	Desabilitar a 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`.	Não	true	true
`deadline_at`	Data limite para a realização das assinaturas no documento. Caso não seja preenchido, será enviado o valor padrão. 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.Uma vez cancelado, o processo não pode ser retomado.	Não	30 dias a partir da criação	2018-06-28T14:30:59-03:00

❗️
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}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
"data": {
	"id": "{{envelopeid}}",
	"type": "envelopes",
	"attributes": {
	"status": "running",
	"name": "Teste",
	"locale": "pt-BR",
	"auto_close": true,
	"remind_interval": 7,
	"block_after_refusal": true,
	"deadline_at": "2023-07-30T18:02:12.933-03:00"
    }
  }
}

Response

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

{
    "data": {
        "id": "34e5af0a-b6cf-446d-99a9-cee39932dafa",
        "type": "envelopes",
        "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa"
        },
        "attributes": {
            "name": "Teste",
            "status": "running",
            "deadline_at": "2023-07-30T18:02:12.933-03:00",
            "locale": "pt-BR",
            "auto_close": true,
            "remind_interval": 7,
            "block_after_refusal": true,
            "created": "2023-07-04T13:46:47.581-03:00",
            "modified": "2023-07-04T13:56:43.039-03:00"
        },
        "relationships": {
            "documents": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/relationships/documents",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/documents"
                }
            },
            "signers": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/relationships/signers",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/signers"
                }
            },
            "requirements": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/relationships/requirements",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/34e5af0a-b6cf-446d-99a9-cee39932dafa/requirements"
                }
            }
        }
    }
}