BOboei
Deals

Update Deal

Update deal details, status, assignment, or temperature.

CRITICAL: Setting outcome (won, lost, abandoned) closes the deal. To move a deal to another pipeline column send status_id from dealStatuses.list instead.

put/deals/{deal_id}

Request

  • Base URL
    https://app.boei.help/api/v1
  • Auth
    HTTP bearer

Request body

namestring

The deal name.

emailstring

Contact email.

phonestring

Contact phone.

companystring

Company name.

valuenumber

Deal value.

sourcestring

Lead source.

notesstring

Internal notes.

external_urlstring

External URL for context.

temperaturestring

Deal temperature (cold, warm, hot).

outcomestring

Terminal outcome (won, lost, abandoned). Setting this closes the deal.

status_idinteger

Pipeline status ID.

row_idinteger

Pipeline row (swimlane) ID.

assigned_tointeger

User ID to assign the deal to.

contact_idstring

Link to existing contact.

domain_idinteger

Move the deal to a different business (must be one you own).

Example request

{
  "name": "Enterprise License v2",
  "email": "john@acme.com",
  "phone": "+1234567890",
  "company": "Acme Corp",
  "value": 7500,
  "source": "API",
  "notes": "Negotiating price",
  "external_url": "https://acme.com/quotes/123",
  "temperature": "hot",
  "outcome": "won",
  "status_id": 2,
  "row_id": 3,
  "assigned_to": 42,
  "contact_id": "con_abc123",
  "domain_id": 42
}

Response

Example response

{
  "data": {
    "id": 19,
    "uuid": "ab0ec9c7-eeae-4871-b594-f90143169d1e",
    "status_id": null,
    "status": null,
    "row_id": null,
    "assigned_to": null,
    "assigned_user": null,
    "notification_id": null,
    "contact_id": null,
    "domain_id": null,
    "name": "Price Ltd deal",
    "email": "okeefe.isidro@example.org",
    "phone": "+19152306227",
    "company": "Schultz Group",
    "source": "Manual",
    "notes": "Fugit deleniti distinctio eum doloremque id aut libero.",
    "external_url": null,
    "value": "8669.00",
    "temperature": "warm",
    "outcome": null,
    "archived_at": null,
    "next_action_at": null,
    "next_auto_follow_up_at": null,
    "auto_follow_up_is_scheduled": false,
    "follow_ups_sent": null,
    "last_auto_follow_up_sent_at": null,
    "last_ai_draft": null,
    "last_ai_draft_at": null,
    "business": null,
    "follow_up_max": null,
    "created_at": "2026-09-10 08:15:02",
    "updated_at": "2026-09-10 08:15:02"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.