BOboei
Deals

Create Deal

Create a new deal. If no status_id is provided, the deal is placed in the first pipeline status.

NOTE: Call dealStatuses.list first to pick a valid status_id; ids differ per account. temperature accepts cold, warm, hot.

post/deals

Request

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

Request body

namestring required

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 (e.g. quote page, contract link).

temperaturestring

Deal temperature (cold, warm, hot).

status_idinteger

Pipeline status ID (uses first status if omitted).

row_idinteger

Optional pipeline row (swimlane) ID.

contact_idstring

Link to existing contact.

domain_idinteger

Business (domain) this deal belongs to. Defaults to the contact's or thread's domain if omitted.

Example request

{
  "name": "Enterprise License",
  "email": "john@acme.com",
  "phone": "+1234567890",
  "company": "Acme Corp",
  "value": 5000,
  "source": "API",
  "notes": "Interested in annual plan",
  "external_url": "https://acme.com/quotes/123",
  "temperature": "warm",
  "status_id": 1,
  "row_id": 3,
  "contact_id": "con_abc123",
  "domain_id": 42
}

Response

Example response

{
  "data": {
    "id": 17,
    "uuid": "36e6abcc-5707-43d4-8f4a-24f97e125af6",
    "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": "dare.emelie@example.com",
    "phone": "+14324666067",
    "company": "Leffler PLC",
    "source": "Manual",
    "notes": "Facere tempora ex voluptatem laboriosam.",
    "external_url": null,
    "value": "3497.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 1 revision of this API.