CRM

Edit the card

Moves the card to another stage or board, changes the owner, marks it as won or lost, and updates status, due date and description. Send only the fields you want to change. The others stay as they are.

The change follows the same rules as the panel: the position within the stage is recalculated when the card changes stage, the origin can be given by name, the card’s history records the change with source api, and automations receive the movement events.

Winning the card (won: true) moves the card to the stage marked as done on the board, fills in wonDate and clears the status. If the board has no done stage, the response is 400 ERR_CRM_BOARD_WITHOUT_DONE_LIST. won: null undoes the win and clears the date.

Products are not changed here. Use PUT /crm/cards/{cardId}/products, which requires a product already registered in the catalog.

The card’s position is not sent here either. It is recalculated automatically when the card changes stage.

PUT

crm

cards

{cardId}

curl --request PUT \
  --url https://api.connectadesk.com/api/v1/crm/cards/{cardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "crmBoardListId": 32,
  "note": "Pagamento confirmado, seguiu para separação."
}
'

{
  "data": {
    "id": 4471,
    "name": "Pedido #88213",
    "description": "Customer asked for a call back on Monday morning.",
    "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."
  }
}

Authorizations

Authorization

string

header

required

API token in the sk_live_… format.

Path Parameters

cardId

integer

required

Body

application/json

Send at least one field. A body with no editable field returns 400.

name

string

Card name.

Example:

"Pedido #88213"

description

string

Card description.

due

string<date-time> | null

Card due date, in ISO 8601. Without a time zone, your company's time zone applies — 2026-09-15T12:00:00 is noon in your operation. With an explicit offset (-03:00) or in UTC (Z), the value is respected as it is.

Example:

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

crmBoardListId

integer

Moves the card to this stage.

Example:

31

crmBoardId

integer

Moves the card to another board.

Example:

7

assignedToUserId

integer | null

Changes the card's owner. null leaves the card with no owner.

Example:

3

crmOriginId

integer | null

Card origin, given by id.

Example:

5

origin

string

Card origin, given by name. If it does not exist yet, it is created.

Example:

"Instagram"

crmBusinessId

integer | null

Business linked to the card.

Example:

9

crmBoardCardStatusId

integer | null

Only cards with this status. Statuses are configured on each stage.

Example:

2

won

boolean | null

true marks the card as won and moves it to the done stage. false marks it as lost. null puts the card back in progress.

statusReason

string

Reason for the win or the loss.

Example:

"Fechou o plano anual."

note

string

Note recorded on the card along with this change.

Example:

"Cliente pediu para ligar depois das 14h."

Response

data

object

A card on a CRM board. The response includes only the fields listed here.

Show child attributes

Example:

{
  "id": 4471,
  "name": "Pedido #88213",
  "description": "Customer asked for a call back on Monday morning.",
  "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"
}

curl --request PUT \
  --url https://api.connectadesk.com/api/v1/crm/cards/{cardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "crmBoardListId": 32,
  "note": "Pagamento confirmado, seguiu para separação."
}
'

{
  "data": {
    "id": 4471,
    "name": "Pedido #88213",
    "description": "Customer asked for a call back on Monday morning.",
    "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."
  }
}

Overview

Endpoints

Edit the card

Authorizations

Path Parameters

Body

Response