Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

Token criado em API → Tokens no painel. Prefixo wtx_live_ (ou wtx_test_).

Corpo

application/json

Exatamente um entre contactId/phone deve vir preenchido.

pipelineId
integer
obrigatório

Mesmo id devolvido em GET /v1/pipelines.

contactId
integer | null

Contato existente da sua conta.

phone
string | null

Cria ou reaproveita o contato por número (mesmo upsert de POST /v1/contacts).

Exemplo:

"5534992341048"

name
string | null

Nome usado se o contato for criado agora via phone.

stageId
integer | null

Precisa ser do MESMO pipeline. Omitido = card criado SEM etapa (stage: null), fora das colunas do kanban — envie sempre este campo.

title
string | null

Default: "API — ".

value
number | null
sourceId
integer | null
notes
string | null
expectedCloseDate
string<date> | null

Data de calendário (YYYY-MM-DD). ISO completo é aceito na entrada e reduzido ao dia em UTC.

customFields
object | null

Campos personalizados do pipeline informado (ou globais da conta) — chave é o nome técnico do campo, valor é o literal já no formato do tipo (select/multiselect precisam bater com as opções cadastradas). Campo inexistente, de outro pipeline/conta ou com valor inválido é IGNORADO (nunca falha a criação) e reportado em ignoredCustomFields na resposta.

Exemplo:

Resposta

Card criado.

requestId
string
card
object
ignoredCustomFields
object[]

Presente só quando algum campo de customFields foi ignorado.