Skip to main content
PATCH
/
api
/
contacts
/
{id}
Patch contact fields
curl --request PATCH \
  --url https://your-instance.example.com/api/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "Qualified",
  "pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2"
}
'
{
  "success": true,
  "message": "Contact updated successfully",
  "data": {
    "contact": {
      "_id": "64f0a1b2c3d4e5f6a7b8c9d0",
      "firstName": "Jane",
      "lastName": "Doe",
      "status": "Qualified"
    },
    "message": "Contact updated successfully"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
status
string

New pipeline status name; resolved alongside pipelineStage and recorded as a pipeline transition.

​
pipelineStage
string | null

Stage _id. null clears the stage; legacy status updates without a resolvable stage fall back to null.

​
pipelineId
string

Optional pipeline _id scoping stage/status resolution.

​
phoneNumber
object[]

Replacement phone-number list; normalized to E.164 and rejected if any value is a provisioned org SMS number.

Response

Contact updated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
message
string
​
contact
object
Example:
{
  "_id": "64f0a1b2c3d4e5f6a7b8c9d0",
  "firstName": "Jane",
  "lastName": "Doe",
  "phoneNumber": [
    {
      "value": "+14165550100",
      "isPrimary": true
    }
  ],
  "secondaryPhoneNumber": [],
  "email": "jane.doe@example.com",
  "status": "New Lead",
  "pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
  "pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2",
  "organizationId": "64f0a1b2c3d4e5f6a7b8c9d3",
  "userId": "64f0a1b2c3d4e5f6a7b8c9d4",
  "createdBy": "64f0a1b2c3d4e5f6a7b8c9d4",
  "assignees": ["64f0a1b2c3d4e5f6a7b8c9d4"],
  "createdAt": "2026-05-01T14:30:00.000Z",
  "updatedAt": "2026-05-15T09:12:00.000Z"
}