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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
enum
required

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

Allowed:
string
required

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

string
required

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

channel_params
object
required

Variáveis de preenchimento do template, por passo (steps[]). Passos do tipo text (mensagens automáticas de fechamento) não precisam ser declarados aqui.

metadata
object

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

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}).

integer

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

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json