Jump to Content

Criação do Aceite via WhatsApp

Requisição para a criação do Aceite via WhatsApp na Clicksign.

Criar Aceite via WhatsApp V3

Esta é uma requisição POST para /api/v3/acceptance_term/whatsapps. No body, deverão ser enviados os atributos do aceite no formato JSON:API.

POST /api/v3/acceptance_term/whatsapps HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: {{access_token}}

Atributos para criação do Aceite via WhatsApp

Atributo	Descrição	Exemplo
`title` Obrigatório	Nome/título do Aceite. Limite máximo configurável (padrão: 255 caracteres).	"Alteração Plano Internet"
`sender_name_option` Obrigatório	Opção para definir automaticamente o nome do remetente. Valores aceitos: `user_name`, `account_name` ou `user_and_account_name`.	`user_name`: "Fernando", `account_name`: "Clicksign", `user_and_account_name`: "Fernando (Clicksign)"
`sender_phone` Opcional	Telefone do remetente para contato. Mínimo de 10 dígitos.	"11999078674"
`message` Obrigatório	Conteúdo do aceite. Limite máximo configurável (padrão: 1500 caracteres).	"Eu, Fulano declaro que fui informado..."
`signer_phone` Obrigatório	Telefone do destinatário que irá receber o aceite em seu WhatsApp. Mínimo de 10 dígitos.	"55999078674"
`signer_name` Obrigatório	Nome do destinatário que irá receber o aceite em seu WhatsApp. Limite máximo configurável (padrão: 200 caracteres).	"Fernando Spacchet"

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

Exemplo completo

Request

POST /api/v3/acceptance_term/whatsapps HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: {{access_token}}

{
  "data": {
    "type": "acceptance_term_whatsapps",
    "attributes": {
      "title": "Alteração Plano Internet",
      "sender_name_option": "user_and_account_name",
      "sender_phone": "55999078674",
      "message": "Eu, Fulano declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99.",
      "signer_phone": "55999078674",
      "signer_name": "Alice Example"
    }
  }
}

Response

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

{
  "data": {
    "id": "037f797b-b472-4258-b0a2-261f7c86e218",
    "type": "acceptance_term_whatsapps",
    "attributes": {
      "title": "Alteração Plano Internet",
      "sender_name": "Fernando Silva (Clicksign)",
      "sender_phone": "55999078674",
      "sender_name_option": "user_and_account_name",
      "message": "Eu, Fulano declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99.",
      "signer_phone": "55999078674",
      "signer_name": "Alice Example",
      "status": "enqueued",
      "status_flow": "initial",
      "sent_at": null,
      "created": "2025-11-27T12:00:00.000Z",
      "modified": "2025-11-27T12:00:00.000Z"
    }
  }
}

📘
O atributo sender_name é retornado na resposta, mas não é aceito como parâmetro de entrada. Ele é derivado automaticamente com base no valor de sender_name_option.

Status do Aceite

Status	Descrição
`enqueued`	Aceite criado e aguardando envio via WhatsApp.
`sent`	Aceite enviado via WhatsApp para o destinatário.
`refused`	Aceite recusado via WhatsApp.
`expired`	Aceite expirado.
`error`	Aceite enviado via WhatsApp com erro.
`completed`	Aceite confirmado pelo destinatário.
`canceled`	Aceite cancelado.

Updated 11 days ago