Skip to main content
POST
/
v1
/
people
Create or update contact
curl --request POST \
  --url https://api.clientcommander.com/v1/people \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "phone": "+15551234567",
  "source": "Website Signup",
  "tags": [
    "VIP",
    "Hot Lead"
  ],
  "price": 450000,
  "timeframe": "3-6 months",
  "background": "Interested in downtown properties"
}
'
{
  "meta": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0.0"
  },
  "data": {
    "created": true,
    "id": "<string>",
    "person": {
      "id": "jd79abc123def",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "createdAt": "2023-11-15T10:00:00Z",
      "emails": [
        {
          "value": "john@example.com",
          "type": "work",
          "isPrimary": false
        }
      ],
      "phones": [
        {
          "value": "+15551234567",
          "type": "mobile",
          "status": "Valid",
          "isPrimary": true,
          "isBad": true
        }
      ],
      "assignedAgentId": "<string>",
      "assignedAgentName": "Jane Smith",
      "assignedAgentEmail": "jsmith@example.com",
      "stageId": "<string>",
      "stageName": "Lead",
      "source": "Website Signup",
      "tags": "VIP, Hot Lead, Referral",
      "price": 450000,
      "timeframe": "3-6 months",
      "background": "<string>",
      "relationship": false,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}

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

Headers

Idempotency-Key
string

Unique key for idempotent requests

Required string length: 16 - 64

Body

application/json
firstName
string
Required string length: 1 - 100
lastName
string
Required string length: 1 - 100
email
string<email>
Maximum string length: 255
phone
string
Pattern: ^\+?[1-9]\d{1,14}$
source
string
Maximum string length: 100
stage
string

Stage ID

price
number<double>
Required range: x >= 0
timeframe
string
Maximum string length: 100
background
string
Maximum string length: 5000
tags
string[]
Maximum array length: 20
Required string length: 1 - 50
street
string
Maximum string length: 200
city
string
Maximum string length: 100
state
string
Maximum string length: 2
Pattern: ^[A-Z]{2}$
zipCode
string
Pattern: ^\d{5}(-\d{4})?$

Response

Contact created or updated successfully

meta
object
required
data
object