Skip to main content
POST
/
v1
/
deals
Create deal
curl --request POST \
  --url https://api.clientcommander.com/v1/deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "123 Main St - Purchase",
  "pipelineId": "k97pipe123",
  "stageId": "k97stage456",
  "peopleIds": [
    "jd79person123"
  ],
  "pricing": 450000,
  "closeDate": "2023-12-31T00:00:00Z"
}
'
{
  "meta": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0.0"
  },
  "data": {
    "id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key for authentication using Bearer token scheme.

How to get your API key:

  1. Log into Client Commander
  2. Go to Admin > API Keys
  3. Click Create API Key
  4. Copy the key and use it in the Authorization header:
Authorization: Bearer ccmd_live_your_key_here

Body

application/json
title
string
required
Required string length: 1 - 200
pipelineId
string
required
stageId
string
peopleIds
string[]
teamIds
string[]
pricing
number<double>

Deal value (maps to 'price' internally)

commission
number<double>
closeDate
string<date-time>

Response

Deal created

meta
object
required
data
object