Solicitar assinatura por e-mail
POST /api/v1/notifications
Requisição para enviar mensagem por e-mail para um signatário solicitando assinatura de um documento ou de um lote. Esse é uma requisiçãoPOSTpara/api/v1/notifications.
POST /api/v1/notifications?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/jsonAtributos da requisição
Atributo | Descrição | Exemplo |
|---|---|---|
| Chave disponível no JSON do documento utilizada nas requisições de notificação e no Widget Embedded.
| 3487ca99-0e37-9754-a9f7-6375c7ea6a0d |
| Mensagem que será enviada no body do e-mail de solicitação de assinatura aos signatários. Utilize | Por favor, assine o documento. |
| URL que será enviada no e-mail de solicitação de assinatura. Este atributo é útil quando for necessário o signatário entrar em uma URL da sua aplicação que contenha o Widget Embedded da Clicksign, e você gostaria que a Clicksign enviasse esse e-mail. Valor padrão é nulo. |
Se a requisição para a Clicksign falharSempre 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/v1/notifications?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json{
"request_signature_key": "0d5a9615-2bb8-3a23-6584-33ff436bb990",
"message": "Prezado João,\nPor favor assine o documento.\n\nQualquer dúvida estou à disposição.\n\nAtenciosamente,\nGuilherme Alvez",
"url": "https://www.example.com/abc"
}Response
HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8Updated about 1 month ago