Skip to main content
POST
/
api
/
contact
Create contact
curl --request POST \
  --url https://your-instance.example.com/api/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "phoneNumber": [
    {
      "value": "+14165550100",
      "isPrimary": true
    }
  ],
  "email": "jane.doe@example.com",
  "status": "New Lead",
  "pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1"
}
'
{
  "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.

Body

application/json
​
phoneNumber
object[]
required

One or more phone-number entries; each value is normalized to E.164 server-side and must be unique within the organization.

​
firstName
string

Contact first name; optional.

​
lastName
string

Contact last name; optional.

​
email
string<email>

Email entries for the contact; normalized server-side. Accepts the same array shape as phoneNumber despite the OpenAPI type.

​
process
string

Optional process/workflow tag carried through to the created contact.

​
status
string

Initial pipeline status name (e.g. New Lead). Defaults to the pipeline's first stage when omitted.

​
pipelineStage
string

Stage _id within the pipeline. Resolved together with status server-side.

​
pipelineId
string

Target Contact pipeline _id. Defaults to the org's active Contact pipeline when omitted.

Response

Contact created

​
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"
}