v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Ativar e Editar Envelope

Ativar ou atualizar configurações de um envelope. <br> Para ativar um envelope na plataforma, cada signatário deve possuir pelo menos um critério de autenticação configurado. Em caso de dúvidas recomendamos a leitura do <Anchor target="_blank" href="https://developers.clicksign.com/docs/guia-de-criacao-o-passo-a-passo-padrao">Guia de criação</Anchor>

patch/envelopes/{envelope_id}

Path parameters

envelope_idstring required

ID do Envelope que deseja atualizar

Headers

Authorizationstring required

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json' required

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "data": {
    "id": "030f3922-68da-47df-bbe4-068c8f9ae432",
    "type": "envelopes",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432"
    },
    "attributes": {
      "name": "Envelope de Teste",
      "status": "running",
      "deadline_at": "2024-03-16T09:50:35.755-03:00",
      "locale": "pt-BR",
      "auto_close": true,
      "rubric_enabled": true,
      "remind_interval": 3,
      "default_message": "Mensagem de envelope\n- com quebra\n- de linhas",
      "created": "2024-02-15T09:50:35.757-03:00",
      "modified": "2024-02-15T09:50:37.662-03:00"
    },
    "relationships": {
      "documents": {
        "links": {
          "self": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/relationships/documents",
          "related": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/documents"
        }
      },
      "signers": {
        "links": {
          "self": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/relationships/signers",
          "related": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/signers"
        }
      },
      "requirements": {
        "links": {
          "self": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/relationships/requirements",
          "related": "https://sandbox.clicksign.com/api/v3/envelopes/030f3922-68da-47df-bbe4-068c8f9ae432/requirements"
        }
      }
    }
  }
}