📘
Requisição para criação de Envelope na Clicksign. Essa é uma requisição POST para /envelopes/. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

POST /api/v3/envelopes 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

Atributos do Envelope

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`name`	O nome do envelope, usado para identificá-lo.	Sim	Sem valor padrão	Documento 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	3	3
`block_after_refusal`	Determina se o processo de assinatura tem que ser pausado ou não após um signatário ter recusado. 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. A data limite do envelope será para todos os documentos criados dentro deste envelope. 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. O valor deve ser maior que a data/hora atual.	Não	30 dias a partir da criação	2018-06-28T14:30:59-03:00
`default_subject`	Define o assunto do e-mail que será enviado aos signatários na solicitação de assinatura. Se esse atributo não for informado, o assunto padrão será enviado. Há um limite para o campo de 100 caracteres.	Não	Sem valor padrão	Solicitação de Assinatura: Contrato de Compra e Venda
default_message	Define a mensagem padrão que será enviada aos signatários. Se esse atributo não for informado, nenhuma mensagem será enviada por padrão. No entanto, é possível enviar uma mensagem específica para cada signatário usando o parâmetro `message` ao disparar notificação de signatário e disparar notificação de Envelope . A mensagem informada no parâmetro `message` terá prioridade sobre a mensagem definida no atributo `default_message`.	Não	Sem valor padrão	Por favor, assine o documento.

Relações da Pasta PCIONAL]

Para definir uma Pasta Origem do envelope adicione a estrutura de relationships:

Atributo	Descrição	Obrigatório	Padrão
relationships	Um objeto com as relações do requisito com outros recursos. Em `\"type\": \"folders\", \"id\": \"{{folder_id}}\"` adicione o `id` gerado ao criar uma pasta."	Não	Sem valor padrão

❗️
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

POST /api/v3/envelopes HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "data": {
    "type": "envelopes",
    "attributes": {
      "name": "Nome do documento",
      "locale": "pt-BR",
      "auto_close": true,
      "remind_interval": 3,
      "block_after_refusal": true,
      "deadline_at": "2023-06-30T18:02:12.933-03:00"
    }
  }
}

Response

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

{
    "data": {
        "id": "55ac485e-4a5e-474b-b794-4f15235f4a0c",
        "type": "envelopes",
        "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c"
        },
        "attributes": {
            "name": "Nome do documento",
            "status": "draft",
            "deadline_at": "2023-06-30T18:02:12.933-03:00",
            "locale": "pt-BR",
            "auto_close": true,
            "remind_interval": 3,
            "block_after_refusal": true,
            "created": "2023-06-27T13:38:19.335-03:00",
            "modified": "2023-06-27T13:38:19.338-03:00"
        },
        "relationships": {
            "documents": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/relationships/documents",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/documents"
                }
            },
            "signers": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/relationships/signers",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/signers"
                }
            },
            "requirements": {
                "links": {
                    "self": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/relationships/requirements",
                    "related": "https://3.clicksign.dev/api/v3/envelopes/55ac485e-4a5e-474b-b794-4f15235f4a0c/requirements"
                }
            }
        }
    }
}

Exemplo completo com pasta

Request

POST /api/v3/envelopes HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "data": {
    "type": "envelopes",
    "attributes": {
      "name": "Nome do documento",
      "locale": "pt-BR",
      "auto_close": true,
      "remind_interval": 3,
      "block_after_refusal": true,
      "deadline_at": "2023-06-30T18:02:12.933-03:00"
    },
    "relationships": {
      "folder": {
        "data": { "id": "55ac485e-4a5e-474b-b794-5f4a0c4f1523", "type": "folders" }
      }
    }
  }
}