---
title: "Create Deal"
method: POST
path: "/deals"
tags: ["Deals"]
---

# Create Deal

`POST /deals`

## Request

- Base URL: `https://app.boei.help/api/v1`
- URL: `https://app.boei.help/api/v1/deals`
- Auth: HTTP bearer

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.

## Request body

- object
  - `name` string, required: The deal name.
  - `email` string: Contact email.
  - `phone` string: Contact phone.
  - `company` string: Company name.
  - `value` number: Deal value.
  - `source` string: Lead source.
  - `notes` string: Internal notes.
  - `external_url` string: External URL for context (e.g. quote page, contract link).
  - `temperature` string: Deal temperature (cold, warm, hot).
  - `status_id` integer: Pipeline status ID (uses first status if omitted).
  - `row_id` integer: Optional pipeline row (swimlane) ID.
  - `contact_id` string: Link to existing contact.
  - `domain_id` integer: Business (domain) this deal belongs to. Defaults to the contact's or thread's domain if omitted.

## Response `200`

- object
  - `data` object
    - `id` integer
    - `uuid` string
    - `status_id` string, nullable
    - `status` string, nullable
    - `row_id` string, nullable
    - `assigned_to` string, nullable
    - `assigned_user` string, nullable
    - `notification_id` string, nullable
    - `contact_id` string, nullable
    - `domain_id` string, nullable
    - `name` string
    - `email` string
    - `phone` string
    - `company` string
    - `source` string
    - `notes` string
    - `external_url` string, nullable
    - `value` string
    - `temperature` string
    - `outcome` string, nullable
    - `archived_at` string, nullable
    - `next_action_at` string, nullable
    - `next_auto_follow_up_at` string, nullable
    - `auto_follow_up_is_scheduled` boolean
    - `follow_ups_sent` string, nullable
    - `last_auto_follow_up_sent_at` string, nullable
    - `last_ai_draft` string, nullable
    - `last_ai_draft_at` string, nullable
    - `business` string, nullable
    - `follow_up_max` string, nullable
    - `created_at` string
    - `updated_at` string

---

[API](https://skmtc.dev/boei/apis/boei-api.md) - [All operations](https://skmtc.dev/boei/apis/boei-api/llms.txt) - [OpenAPI document](https://skmtc.dev/boei/apis/boei-api/revisions/fc439667d2d4?raw)