Jump to Content

Cancelar envio de Aceite via WhatsApp

Requisição para cancelar um Aceite via WhatsApp na Clicksign.

Cancelar Aceite via WhatsApp V3

Esta é uma requisição PATCH para /api/v3/acceptance_term/whatsapps/:id, sendo :id a chave do Aceite via WhatsApp.

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

⚠️
Importante: Apenas Aceites com status sent podem ser cancelados. Aceites com outros status retornarão erro 422 (Unprocessable Entity).

Atributos para cancelamento

Atributo	Descrição	Valor
`status` Obrigatório	Novo status do Aceite. Único valor aceito para cancelamento.	"canceled"

Exemplo completo

Request

PATCH /api/v3/acceptance_term/whatsapps/037f797b-b472-4258-b0a2-261f7c86e218 HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: {{access_token}}

{
  "data": {
    "id": "037f797b-b472-4258-b0a2-261f7c86e218",
    "type": "acceptance_term_whatsapps",
    "attributes": {
      "status": "canceled"
    }
  }
}

Response

HTTP/1.1 200 OK
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.",
      "signer_phone": "55999078674",
      "signer_name": "Alice Example",
      "status": "canceled",
      "status_flow": "canceled",
      "sent_at": "2025-11-27T12:05:00.000Z",
      "created": "2025-11-27T12:00:00.000Z",
      "modified": "2025-11-27T12:10:00.000Z"
    }
  }
}

Erros comuns

Status	Código	Descrição
404	Not Found	Aceite não encontrado ou não pertence à conta autenticada.
422	Unprocessable Entity	Aceite não pode ser cancelado. Apenas Aceites com status `sent` podem ser cancelados.

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

Updated 11 days ago