Create a deal

Create a new deal in your workspace.

POST /deals

Create a deal

cURL

curl --request POST \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/deals \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "deal": {
    "name": "Eve Enterprise Deal",
    "value": 10000,
    "currency": "USD",
    "status": "in_progress",
    "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "contact_id": 1,
    "owner_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "stage_id": 1,
    "pipeline_id": 1,
    "position": 1,
    "tag_ids": [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    ]
  }
}
'

201

{
  "deal": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Eve Enterprise Deal",
    "status": "in_progress",
    "value": 10000,
    "currency": "USD",
    "price": "$ 10000",
    "unique_number": "D-001",
    "contact_name": "Eve",
    "contact_id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "company_name": "Eve Corp",
    "company_id": "d2e3f4a5-b6c7-8901-def0-234567890123",
    "owner": null,
    "pipeline": null,
    "stage": null,
    "tags": [],
    "created_at": "2025-03-15T10:30:00.000Z",
    "updated_at": "2025-03-15T10:30:00.000Z"
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

deal · object

Hide child attributes

deal. name · string · required

Deal name.

Example:

"Eve Enterprise Deal"

deal. value · number

Monetary value of the deal.

Example:

10000

deal. currency · string

Currency code (default: USD).

Example:

"USD"

deal. status · enum<string>

Deal status.

Available options: in_progress, won, lost

Example:

"in_progress"

deal. company_id · string

Unique identifier of the associated company.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

deal. contact_id · integer

Associated contact ID.

Example:

1

deal. owner_id · string

Unique identifier of the owner.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

deal. stage_id · integer

Stage ID.

Example:

1

deal. pipeline_id · integer

Pipeline ID.

Example:

1

deal. position · integer

Position in pipeline.

Example:

1

deal. tag_ids · string[]

Array of tag IDs.

Example:

[
  "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "b2c3d4e5-f6a7-8901-bcde-f12345678901"
]

Response

201 - application/json

Deal created successfully.

deal · object

Hide child attributes

deal. id · string

Unique identifier for the deal.

deal. name · string

Name of the deal.

deal. status · enum<string>

Current status of the deal.

Available options: in_progress, won, lost

deal. value · number

Monetary value of the deal.

deal. currency · string

Currency code for the deal value.

deal. price · string

Formatted price string (e.g. "$ 10000").

deal. unique_number · string

Auto-generated unique number for the deal.

deal. contact_name · string | null

Name of the associated contact.

deal. contact_id · string | null

Unique identifier of the associated contact.

deal. company_name · string | null

Name of the associated company.

deal. company_id · string | null

Unique identifier of the associated company.

deal. owner · object

Owner of the deal.

Hide child attributes

deal.owner. id · string

Unique identifier of the owner.

deal.owner. name · string

Name of the owner.

deal. pipeline · object

Pipeline the deal belongs to.

Hide child attributes

deal.pipeline. id · string

Unique identifier of the pipeline.

deal.pipeline. name · string

Name of the pipeline.

deal. stage · object

Current stage of the deal within the pipeline.

Hide child attributes

deal.stage. id · string

Unique identifier of the stage.

deal.stage. name · string

Name of the stage.

deal. tags · object[]

Tags associated with the deal.

Hide child attributes

deal.tags. id · string

Unique identifier for the tag.

deal.tags. name · string

Name of the tag.

deal.tags. style · string

Style/color of the tag.

deal. created_at · string<date-time>

Timestamp when the deal was created.

deal. updated_at · string<date-time>

Timestamp when the deal was last updated.