Skip to main content
POST
/
2025-09
/
deals
Create a Deal
curl --request POST \
  --url https://public-api.stora.co/2025-09/deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp Storage",
  "contact": {
    "id": "con_1234567890abcdef"
  },
  "stage": {
    "id": "dstg_127b3057d5df338e"
  },
  "line_items": [
    {
      "type": "unit_type",
      "item": {
        "id": "utype_f18fc91387cdf710"
      }
    },
    {
      "type": "protection",
      "item": {
        "id": "plvl_e8f3ad0a07e47566"
      }
    }
  ]
}
'
{
  "deal": {
    "id": "deal_a1b2c3d4e5f67890",
    "assignee": null,
    "contact": {
      "id": "con_1234567890abcdef"
    },
    "created_at": "2025-02-22T14:41:00Z",
    "creator": {
      "id": "app_99b90b9d208a137b"
    },
    "line_items": [
      {
        "item": {
          "id": "plvl_e8f3ad0a07e47566"
        },
        "quantity": 1,
        "type": "protection"
      },
      {
        "item": {
          "id": "utype_f18fc91387cdf710"
        },
        "quantity": 1,
        "type": "unit_type"
      }
    ],
    "lost_reason": null,
    "metadata": {},
    "name": "Acme Corp Storage",
    "note": null,
    "site": null,
    "stage": {
      "id": "dstg_127b3057d5df338e"
    },
    "starts_at": null,
    "status": "open",
    "updated_at": "2025-02-22T14:41:00Z",
    "value_estimate": null
  },
  "meta": {
    "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
    "curies": [
      {
        "name": "bo",
        "href": "https://app.stora.test{rel}",
        "templated": true,
        "title": "Backoffice"
      },
      {
        "name": "sf",
        "href": "https://acme.stora.test{rel}",
        "templated": true,
        "title": "Storefront"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stora.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Body

application/json

Create Deal Request

name
string
required

The name of the deal

contact
object
required
stage
object
required
assignee
object
site
object
note
string | null

Free-text note for the deal. Displayed under 'Deal value estimate' in Backoffice.

starts_at
string<date-time> | null

The intended move-in date

metadata
object

Set of key-value pairs for storing additional information on the deal. Learn more about metadata.

line_items
object[] | null

List of line items for the deal. At most one item per type is allowed.

Maximum array length: 2

Deal Unit Type Line Item

Response

deal successfully created

Single Deal

deal
object

Deal

meta
object