Skip to main content
PUT

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de caminho

cardId
integer
obrigatório

Corpo

application/json

Envie ao menos um campo. Um corpo sem nenhum campo alterável responde 400.

name
string

Nome do card.

Exemplo:

"Pedido #88213"

description
string

Descrição do card.

due
string<date-time> | null

Prazo do card, no formato ISO 8601. Sem fuso, vale o fuso da sua empresa — 2026-09-15T12:00:00 é meio-dia na sua operação. Com fuso explícito (-03:00) ou em UTC (Z), o valor é respeitado como está.

Exemplo:

"2026-09-15T12:00:00-03:00"

crmBoardListId
integer

Move o card para esta etapa.

Exemplo:

31

crmBoardId
integer

Move o card para outro painel.

Exemplo:

7

assignedToUserId
integer | null

Troca o responsável pelo card. null deixa o card sem responsável.

Exemplo:

3

crmOriginId
integer | null

Origem do card, informada pelo id.

Exemplo:

5

origin
string

Origem do card, informada pelo nome. Se ainda não existir, é criada.

Exemplo:

"Instagram"

crmBusinessId
integer | null

Negócio vinculado ao card.

Exemplo:

9

crmBoardCardStatusId
integer | null

Só os cards com este status. Os status são configurados em cada etapa.

Exemplo:

2

won
boolean | null

true marca o card como ganho e move para a etapa de conclusão. false marca como perdido. null volta o card para em andamento.

statusReason
string

Motivo do ganho ou da perda.

Exemplo:

"Fechou o plano anual."

note
string

Anotação registrada no card junto com esta alteração.

Exemplo:

"Cliente pediu para ligar depois das 14h."

Resposta

OK

data
object

Card de um painel do CRM. A resposta traz apenas os campos listados aqui.

Exemplo: