Skip to main content
POST
Cria ou atualiza um chat DM

Authorizations

X-API-Key
string
header
required

Body

application/json
entrypointId
string
required

ID do ponto de entrada (canal) no Spark. A plataforma é inferida automaticamente (WhatsApp ou WhatsApp Lite).

phone
string
required

Telefone do contato em qualquer formato comum. Será normalizado para o padrão E.164 da plataforma (ex.: 5511999999999).

Required string length: 3 - 40
name
string

Nome exibido no chat (conversa DM). Se omitido, o chat é criado sem nome personalizado. Ao reutilizar um chat existente, atualiza o nome quando informado.

Required string length: 1 - 255
triggerAutomations
boolean
default:true

Se verdadeiro (padrão), dispara automações ao criar um novo lead ou chat.

Response

Chat já existia para este entrypoint e telefone; IDs retornados sem criar duplicata. O nome do chat é atualizado quando informado.

chatId
string
required

ID do chat no Spark.

leadId
string
required

ID do lead vinculado ao chat (criado nesta requisição ou já existente).