CLclicksign
Acceptances

Cria um aceite

Cria um novo fluxo de aceite. O serviço persiste o registro, publica na fila interna e retorna imediatamente com status PENDING — a validação do template e o envio da mensagem ao canal acontecem de forma assíncrona. O channel_params da requisição não contém a definição completa do template (nome, idioma) — apenas os valores das variáveis por passo; a definição fica armazenada do lado da Clicksign, associada ao template_id.

post/api/v1/acceptances

Request

  • Base URL
    http://app-acceptance-sandbox.clicksign.com
  • URL
    http://app-acceptance-sandbox.clicksign.com/api/v1/acceptances
  • Auth
    API key in header X-API-Key and API key in header X-API-Secret

Request body

execution_idstring required

ID do fluxo/execução no seu sistema, para correlação.

channel_type'whatsapp' required

Canal de entrega. Único valor válido hoje: whatsapp.

destinationstring required

Destinatário no formato do canal (ex.: número E.164 para WhatsApp).

template_idstring required

ID do template cadastrado junto à Clicksign para a sua conta.

metadataobject

Dados livres associados ao aceite — devolvidos no relatório e no recibo final (ex.: identificadores de contrato, nome/e-mail do destinatário).

webhook_urlstring uri

URL que receberá o recibo final (POST) quando o aceite atingir um status final. Opcional — se omitido, o recibo não é entregue via HTTP (o histórico continua disponível via GET /api/v1/reports/{id}).

expiration_timeinteger

Tempo de expiração em segundos a partir da criação. Se omitido, usa o padrão do serviço.

Response

Aceite criado e enfileirado para processamento assíncrono.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.