Update a deal

​

Updates a deal. Every field is optional, and anything you leave out keeps its current value.

Send board_group_id to move the deal to another stage of your pipeline — that is how you advance a deal, mark it won, or mark it lost.

Changing company_id moves the deal to a different client and re-points its contact to that client's primary contact. To choose the contacts yourself, send contact_ids as well: it replaces the deal's contacts with exactly the ids you give, and wins over the automatic re-point.

Path Parameters
  • id
    Type: integer
    required

    Id of the deal to update.

Body
required
application/json

The attributes to change, wrapped in a deal key. All of them are optional.

  • deal
    Type: object
    required
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/public-api/v1/deals/{id}
curl https://app.hellobonsai.com/public-api/v1/deals/1 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "deal": {
    "title": "Acme Website Redesign",
    "company_id": 42,
    "contact_ids": [
      7,
      12
    ],
    "assignee_member_id": "me",
    "board_group_id": "8feddf83-f0dc-4587-ac77-3236d509a5c4",
    "deal_value": "7500.00",
    "probability": 60,
    "close_date": "2026-09-30"
  }
}'

{
  "data": {
    "id": 918,
    "title": "Acme Website Redesign",
    "deal_number": "DL-42",
    "deal_value": "5000.00",
    "currency": "USD",
    "probability": 60,
    "close_date": "2026-09-30",
    "archived_at": "2026-04-14T09:12:04.000Z",
    "assignee_member_id": 314,
    "board_group_id": "8feddf83-f0dc-4587-ac77-3236d509a5c4",
    "status": "Won",
    "company_name": "Acme Corp",
    "assignee_member_name": "Maria Santos",
    "contact_ids": [
      7,
      12
    ],
    "url": "https://app.hellobonsai.com/deals?deal_id=918"
  },
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e"
  }
}

The deal was updated.