Skip to main content
POST
Criar card

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Corpo

application/json
name
string
obrigatório

Nome do card.

Exemplo:

"Pedido #88213"

crmBoardId
integer
obrigatório

Painel do CRM.

Exemplo:

7

crmBoardListId
integer
obrigatório

Etapa do painel em que o card é criado.

Exemplo:

31

description
string

Descrição do card.

origin
string

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

Exemplo:

"Instagram"

assignedToUserId
integer

Atendente responsável pelo card. Use o id do usuário nesta empresa, o mesmo que GET /users devolve. A mesma pessoa tem um id diferente em cada empresa em que trabalha.

Exemplo:

3

crmBusinessId
integer

Negócio vinculado ao card.

Exemplo:

9

crmBoardCardStatusId
integer

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

Exemplo:

2

customFields
object[]

Campos personalizados de CRM que serão gravados no card novo. Se algum valor não passar na validação do tipo do campo, a resposta é 400 e o card não é criado.

products
object[]

Produtos do card. Cada item aponta para um produto já cadastrado no catálogo. A API não cria produtos novos por aqui.

Resposta

Criado. Devolve o card completo, com contacts, customFields e products, incluindo os que foram enviados nesta requisição. Você não precisa fazer um GET logo depois do POST.

data
object

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

Exemplo: