📘
Requisição para notificação de envelope. Essa é uma requisição POST para /envelopes/{{envelopeid}}/notifications, sendo {{envelopeid}}a variável id gerada na criação do envelope. Em Authorizationadicione o access token de sua conta. Notifica apenas os signatários do grupo atual. No body, deverão ser enviados os atributos listados abaixo.

POST /api/v3/envelopes/{{envelopeid}}/notifications 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 `notifications`.	Sim

Atributo da notificação de Envelope

Atributo Descrição Obrigatório Padrão Exemplo

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`message`	A mensagem personalizada que será enviada ao signatário. Esse atributo pode ser customizado em caso de notificações por `email`. Em casos de notificações por `whatsapp` ou `sms`, o campo `message` é desconsiderado. A mensagem informada no parâmetro `message` terá prioridade sobre a mensagem definida no atributo `default_message` definido ao criar ou alterar o Envelope.	Não	Sem valor padrão	Teste

message

A mensagem personalizada que será enviada ao signatário.

Esse atributo pode ser customizado em caso de notificações por email. Em casos de notificações por whatsapp ou sms, o campo message é desconsiderado.

A mensagem informada no parâmetro message terá prioridade sobre a mensagem definida no atributo default_message definido ao criar ou alterar o Envelope.

Não

Sem valor padrão

Teste

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

{
  "data": {
    "type": "notifications",
    "attributes": {
        "message": "Teste"
    }
  }
}

Response

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

{
    "data": {
        "id": "836489bf-11e0-4363-9b0f-db89088af15d",
        "type": "notifications",
        "attributes": {
            "message": "Teste",
            "summary": [
                {
                    "signer_id": "94f93013-506c-47cd-88c0-3f72d89e080d",
                    "notified": true
                }
            ],
            "created": "2023-07-04T14:03:07.749-03:00"
        }
    }
}