Skip to main content
PUT
/
v1
/
people
/
{id}
Update contact
curl --request PUT \
  --url https://api.clientcommander.com/v1/people/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "source": "<string>",
  "stage": "<string>",
  "price": 1,
  "timeframe": "<string>",
  "background": "<string>",
  "tags": [
    "<string>"
  ],
  "street": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>"
}
'
{
  "meta": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0.0"
  },
  "success": true,
  "message": "Operation completed successfully"
}

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

Path Parameters

id
string
required

Contact ID

Pattern: ^[a-zA-Z0-9_-]{8,}$

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 updated successfully

meta
object
required
success
boolean
Example:

true

message
string
Example:

"Operation completed successfully"