Create deal

POST/workspaces/{organizationId}/deals

Path parameters

organizationIdstringrequired

Request body

application/json

customerIdstringrequired

namestringrequired

min length 1

stagestring

default: "lead"

Allowed:leadqualifiedproposalnegotiationwonlost

amountCentsinteger | null

min 0

currencystring | null

min length 3 · max length 3

expectedCloseAtstring | null

descriptionstring | null

contactIdsstring[]

Responses

201

Created deal

dealobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

customerIdstringrequired

namestringrequired

stagestringrequired

Allowed:leadqualifiedproposalnegotiationwonlost

amountCentsnumber | nullrequired

currencystring | nullrequired

expectedCloseAtstring | nullrequired

descriptionstring | nullrequired

closedAtstring | nullrequired

archivedAtstring | nullrequired

contactIdsstring[]required

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/deals' \
  -H 'Content-Type: application/json' \
  -d '{
  "customerId": "string",
  "name": "string",
  "stage": "lead",
  "amountCents": 0,
  "currency": "str",
  "expectedCloseAt": "string",
  "description": "string",
  "contactIds": [
    "string"
  ]
}'

const response = await fetch("/workspaces/string/deals", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"customerId\": \"string\",\n  \"name\": \"string\",\n  \"stage\": \"lead\",\n  \"amountCents\": 0,\n  \"currency\": \"str\",\n  \"expectedCloseAt\": \"string\",\n  \"description\": \"string\",\n  \"contactIds\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "/workspaces/string/deals",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"customerId\": \"string\",\n  \"name\": \"string\",\n  \"stage\": \"lead\",\n  \"amountCents\": 0,\n  \"currency\": \"str\",\n  \"expectedCloseAt\": \"string\",\n  \"description\": \"string\",\n  \"contactIds\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "deal": {
    "id": "string",
    "organizationId": "string",
    "customerId": "string",
    "name": "string",
    "stage": "lead",
    "amountCents": 0,
    "currency": "string",
    "expectedCloseAt": "string",
    "description": "string",
    "closedAt": "string",
    "archivedAt": "string",
    "contactIds": [
      "string"
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}