<!-- Source: https://docs.vinsi.ai/api-docs/crm-deal-create -->
# Create Deal

Create a CRM deal. dealName is required. Defaults: pipeline Sales Pipeline, dealStage Appointment Scheduled, type one-time. For recurring deals set type to recurring with billingFrequency (Monthly, Quarterly, Semi-Annual, Annual) and recurringAmount. A deal created in a won stage must include amount (or recurringAmount for recurring deals), otherwise 400. Responds 201 and runs deal_created CRM workflows.

```http
POST https://dashboard.vinsi.ai/api/crm/deals
```

## Authentication

Send your API key in the `x-api-key` header. Create keys in the VINSI dashboard under Settings → API Keys.

## Headers

| Name | Type | Required |
|---|---|---|
| Content-Type | string | yes (application/json) |
| x-api-key | string | yes |

## Example request body

```json
{
  "dealName": "Acme Dental - Annual Plan",
  "pipeline": "Sales Pipeline",
  "dealStage": "Appointment Scheduled",
  "amount": 12000,
  "closeDate": "2026-10-31",
  "dealOwnerId": "cmexampleuser0000000000001",
  "dealType": "New Business",
  "priority": "High",
  "contactId": 1042,
  "companyId": 318,
  "type": "one-time",
  "billingFrequency": null,
  "recurringAmount": null
}
```

## Example request

```bash
curl -X POST 'https://dashboard.vinsi.ai/api/crm/deals' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"dealName":"Acme Dental - Annual Plan","pipeline":"Sales Pipeline","dealStage":"Appointment Scheduled","amount":12000,"closeDate":"2026-10-31","dealOwnerId":"cmexampleuser0000000000001","dealType":"New Business","priority":"High","contactId":1042,"companyId":318,"type":"one-time","billingFrequency":null,"recurringAmount":null}'
```

## Example response

```json
{
  "id": 77,
  "organizationId": "cmexampleorg00000000000001",
  "dealName": "Acme Dental - Annual Plan",
  "pipeline": "Sales Pipeline",
  "dealStage": "Appointment Scheduled",
  "amount": 12000,
  "closeDate": "2026-10-31T00:00:00.000Z",
  "dealOwnerId": "cmexampleuser0000000000001",
  "dealType": "New Business",
  "priority": "High",
  "contactId": 1042,
  "companyId": 318,
  "createdAt": "2026-09-05T16:00:00.000Z",
  "updatedAt": "2026-09-05T16:00:00.000Z",
  "type": "one-time",
  "billingFrequency": null,
  "recurringAmount": null
}
```