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"
}
'import requests
url = "https://your-instance.example.com/api/contact"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": [
{
"value": "+14165550100",
"isPrimary": True
}
],
"email": "jane.doe@example.com",
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'Jane',
lastName: 'Doe',
phoneNumber: [{value: '+14165550100', isPrimary: true}],
email: 'jane.doe@example.com',
status: 'New Lead',
pipelineId: '64f0a1b2c3d4e5f6a7b8c9d1'
})
};
fetch('https://your-instance.example.com/api/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/contact",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'Jane',
'lastName' => 'Doe',
'phoneNumber' => [
[
'value' => '+14165550100',
'isPrimary' => true
]
],
'email' => 'jane.doe@example.com',
'status' => 'New Lead',
'pipelineId' => '64f0a1b2c3d4e5f6a7b8c9d1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contact"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/contact")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Contact updated successfully",
"data": {
"contact": {
"_id": "64f0a1b2c3d4e5f6a7b8c9d0",
"firstName": "Jane",
"lastName": "Doe",
"status": "Qualified"
},
"message": "Contact updated successfully"
}
}{
"success": true,
"message": "Contact updated successfully",
"data": {
"contact": {
"_id": "64f0a1b2c3d4e5f6a7b8c9d0",
"firstName": "Jane",
"lastName": "Doe",
"status": "Qualified"
},
"message": "Contact updated successfully"
}
}{
"success": false,
"message": "Contact not found",
"error": {
"code": "NOT_FOUND",
"message": "Contact not found"
}
}Create contact
Creates a new Contact in the caller’s organization, normalizing phone numbers and emails and assigning the contact to the requested pipeline + stage (defaulting to the org’s Contact pipeline and its first stage). Rejects provisioned org SMS numbers. Emits the contact_created socket event and logs a manual event.
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"
}
'import requests
url = "https://your-instance.example.com/api/contact"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": [
{
"value": "+14165550100",
"isPrimary": True
}
],
"email": "jane.doe@example.com",
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'Jane',
lastName: 'Doe',
phoneNumber: [{value: '+14165550100', isPrimary: true}],
email: 'jane.doe@example.com',
status: 'New Lead',
pipelineId: '64f0a1b2c3d4e5f6a7b8c9d1'
})
};
fetch('https://your-instance.example.com/api/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/contact",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'Jane',
'lastName' => 'Doe',
'phoneNumber' => [
[
'value' => '+14165550100',
'isPrimary' => true
]
],
'email' => 'jane.doe@example.com',
'status' => 'New Lead',
'pipelineId' => '64f0a1b2c3d4e5f6a7b8c9d1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contact"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/contact")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": [\n {\n \"value\": \"+14165550100\",\n \"isPrimary\": true\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Contact updated successfully",
"data": {
"contact": {
"_id": "64f0a1b2c3d4e5f6a7b8c9d0",
"firstName": "Jane",
"lastName": "Doe",
"status": "Qualified"
},
"message": "Contact updated successfully"
}
}{
"success": true,
"message": "Contact updated successfully",
"data": {
"contact": {
"_id": "64f0a1b2c3d4e5f6a7b8c9d0",
"firstName": "Jane",
"lastName": "Doe",
"status": "Qualified"
},
"message": "Contact updated successfully"
}
}{
"success": false,
"message": "Contact not found",
"error": {
"code": "NOT_FOUND",
"message": "Contact not found"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
One or more phone-number entries; each value is normalized to E.164 server-side and must be unique within the organization.
Show child attributes
Show child attributes
Contact first name; optional.
Contact last name; optional.
Email entries for the contact; normalized server-side. Accepts the same array shape as phoneNumber despite the OpenAPI type.
Optional process/workflow tag carried through to the created contact.
Initial pipeline status name (e.g. New Lead). Defaults to the pipeline's first stage when omitted.
Stage _id within the pipeline. Resolved together with status server-side.
Target Contact pipeline _id. Defaults to the org's active Contact pipeline when omitted.
Response
Contact created
true Show child attributes
Show child attributes
Show child attributes
Show child attributes
{
"_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"
}