Editar o card
Move o card de etapa ou de painel, troca o responsável, marca como ganho ou perdido e altera status, prazo e descrição. Informe só os campos que quer alterar. Os demais ficam como estão.
A alteração segue as mesmas regras do painel: a posição dentro da etapa é recalculada quando o card muda de etapa, a origem pode ser informada pelo nome, o histórico do card registra a mudança com origem api e as automações recebem os eventos de movimentação.
Ganhar o card (won: true) move o card para a etapa marcada como concluída no painel, preenche wonDate e limpa o status. Se o painel não tiver etapa de conclusão, a resposta é 400 ERR_CRM_BOARD_WITHOUT_DONE_LIST. won: null desfaz o ganho e limpa a data.
Os produtos não são alterados por aqui. Use PUT /crm/cards/{cardId}/products, que exige produto já cadastrado no catálogo.
A posição do card também não é enviada por aqui. Ela é recalculada automaticamente quando o card muda de etapa.
{
"data": {
"id": 4471,
"name": "Pedido #88213",
"description": "Cliente pediu retorno na segunda de manhã.",
"won": false,
"wonDate": null,
"statusReason": null,
"boardId": 7,
"list": {
"id": 31,
"name": "Aguardando envio"
},
"status": {
"id": 2,
"name": "Em negociação",
"color": "#F59E0B"
},
"business": {
"id": 9,
"name": "Varejo"
},
"origin": {
"id": 5,
"name": "Instagram"
},
"assignedTo": {
"id": 3,
"name": "Gabriel Goulart"
},
"contacts": [
{
"id": 1042,
"name": "Marina Alves",
"number": "5511999999999",
"email": "marina@exemplo.com.br",
"code": "CLI-8842",
"cpfCnpj": "12345678909",
"origin": "Site",
"profilePicUrl": "https://cdn.exemplo.com.br/avatar/1042.jpg",
"isGroup": false,
"instagramUsername": "marina.alves",
"sourceUrl": "https://loja.exemplo.com.br/promo",
"sourceId": "23851234567890123",
"headline": "Coleção de inverno",
"utmSource": "instagram",
"utmMedium": "cpc",
"utmCampaign": "inverno-2026",
"utmId": "6543210987",
"tags": [
{
"id": 3,
"name": "Cliente VIP",
"color": "#6941C6"
}
],
"customFields": [
{
"key": "plano",
"value": "Ouro",
"customFieldId": 91,
"name": "Plano",
"type": "select"
}
],
"lastChannel": {
"id": 11,
"name": "Instagram Loja",
"type": "instagram"
},
"createdAt": "2026-07-14T13:22:05.412Z",
"updatedAt": "2026-08-18T09:41:17.883Z"
}
],
"products": [
{
"id": 812,
"productId": 55,
"name": "Camiseta preta M",
"sku": "CAM-PRETA-M",
"quantity": 2,
"unitPrice": 149.9,
"totalPrice": 299.8
}
],
"productsTotal": 299.8,
"customFields": [
{
"key": "prioridade",
"value": "Alta",
"customFieldId": 77,
"name": "Prioridade",
"type": "select"
}
],
"creationSource": "api",
"due": "2026-09-15T12:00:00.000Z",
"createdAt": "2026-09-08T14:32:10.000Z",
"updatedAt": "2026-09-08T16:02:44.000Z"
}
}{
"error": {
"code": "ERR_CRM_BOARD_WITHOUT_DONE_LIST",
"message": "O painel não tem etapa marcada como concluída."
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}{
"error": {
"code": "ERR_API_RATE_LIMIT",
"message": "Limite de requisições por minuto excedido para esta empresa."
}
}Autorizações
Token da API no formato sk_live_….
Parâmetros de caminho
Corpo
Envie ao menos um campo. Um corpo sem nenhum campo alterável responde 400.
Nome do card.
"Pedido #88213"
Descrição do card.
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á.
"2026-09-15T12:00:00-03:00"
Move o card para esta etapa.
31
Move o card para outro painel.
7
Troca o responsável pelo card. null deixa o card sem responsável.
3
Origem do card, informada pelo id.
5
Origem do card, informada pelo nome. Se ainda não existir, é criada.
"Instagram"
Negócio vinculado ao card.
9
Só os cards com este status. Os status são configurados em cada etapa.
2
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.
Motivo do ganho ou da perda.
"Fechou o plano anual."
Anotação registrada no card junto com esta alteração.
"Cliente pediu para ligar depois das 14h."
Resposta
OK
Card de um painel do CRM. A resposta traz apenas os campos listados aqui.
Show child attributes
Show child attributes
{ "id": 4471, "name": "Pedido #88213", "description": "Cliente pediu retorno na segunda de manhã.", "won": false, "wonDate": null, "statusReason": null, "boardId": 7, "list": { "id": 31, "name": "Aguardando envio" }, "status": { "id": 2, "name": "Em negociação", "color": "#F59E0B" }, "business": { "id": 9, "name": "Varejo" }, "origin": { "id": 5, "name": "Instagram" }, "assignedTo": { "id": 3, "name": "Gabriel Goulart" }, "contacts": [ { "id": 1042, "name": "Marina Alves", "number": "5511999999999", "email": "marina@exemplo.com.br", "code": "CLI-8842", "cpfCnpj": "12345678909", "origin": "Site", "profilePicUrl": "https://cdn.exemplo.com.br/avatar/1042.jpg", "isGroup": false, "instagramUsername": "marina.alves", "sourceUrl": "https://loja.exemplo.com.br/promo", "sourceId": "23851234567890123", "headline": "Coleção de inverno", "utmSource": "instagram", "utmMedium": "cpc", "utmCampaign": "inverno-2026", "utmId": "6543210987", "tags": [ { "id": 3, "name": "Cliente VIP", "color": "#6941C6" } ], "customFields": [ { "key": "plano", "value": "Ouro", "customFieldId": 91, "name": "Plano", "type": "select" } ], "lastChannel": { "id": 11, "name": "Instagram Loja", "type": "instagram" }, "createdAt": "2026-07-14T13:22:05.412Z", "updatedAt": "2026-08-18T09:41:17.883Z" } ], "products": [ { "id": 812, "productId": 55, "name": "Camiseta preta M", "sku": "CAM-PRETA-M", "quantity": 2, "unitPrice": 149.9, "totalPrice": 299.8 } ], "productsTotal": 299.8, "customFields": [ { "key": "prioridade", "value": "Alta", "customFieldId": 77, "name": "Prioridade", "type": "select" } ], "creationSource": "api", "due": "2026-09-15T12:00:00.000Z", "createdAt": "2026-09-08T14:32:10.000Z", "updatedAt": "2026-09-08T16:02:44.000Z" }
{
"data": {
"id": 4471,
"name": "Pedido #88213",
"description": "Cliente pediu retorno na segunda de manhã.",
"won": false,
"wonDate": null,
"statusReason": null,
"boardId": 7,
"list": {
"id": 31,
"name": "Aguardando envio"
},
"status": {
"id": 2,
"name": "Em negociação",
"color": "#F59E0B"
},
"business": {
"id": 9,
"name": "Varejo"
},
"origin": {
"id": 5,
"name": "Instagram"
},
"assignedTo": {
"id": 3,
"name": "Gabriel Goulart"
},
"contacts": [
{
"id": 1042,
"name": "Marina Alves",
"number": "5511999999999",
"email": "marina@exemplo.com.br",
"code": "CLI-8842",
"cpfCnpj": "12345678909",
"origin": "Site",
"profilePicUrl": "https://cdn.exemplo.com.br/avatar/1042.jpg",
"isGroup": false,
"instagramUsername": "marina.alves",
"sourceUrl": "https://loja.exemplo.com.br/promo",
"sourceId": "23851234567890123",
"headline": "Coleção de inverno",
"utmSource": "instagram",
"utmMedium": "cpc",
"utmCampaign": "inverno-2026",
"utmId": "6543210987",
"tags": [
{
"id": 3,
"name": "Cliente VIP",
"color": "#6941C6"
}
],
"customFields": [
{
"key": "plano",
"value": "Ouro",
"customFieldId": 91,
"name": "Plano",
"type": "select"
}
],
"lastChannel": {
"id": 11,
"name": "Instagram Loja",
"type": "instagram"
},
"createdAt": "2026-07-14T13:22:05.412Z",
"updatedAt": "2026-08-18T09:41:17.883Z"
}
],
"products": [
{
"id": 812,
"productId": 55,
"name": "Camiseta preta M",
"sku": "CAM-PRETA-M",
"quantity": 2,
"unitPrice": 149.9,
"totalPrice": 299.8
}
],
"productsTotal": 299.8,
"customFields": [
{
"key": "prioridade",
"value": "Alta",
"customFieldId": 77,
"name": "Prioridade",
"type": "select"
}
],
"creationSource": "api",
"due": "2026-09-15T12:00:00.000Z",
"createdAt": "2026-09-08T14:32:10.000Z",
"updatedAt": "2026-09-08T16:02:44.000Z"
}
}{
"error": {
"code": "ERR_CRM_BOARD_WITHOUT_DONE_LIST",
"message": "O painel não tem etapa marcada como concluída."
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}{
"error": {
"code": "ERR_API_RATE_LIMIT",
"message": "Limite de requisições por minuto excedido para esta empresa."
}
}
