curl --request POST \
--url https://api.ciarem.ai/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"sub_origin_id": "<string>",
"sub_origin_key": "<string>",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"properties": {}
}
'import requests
url = "https://api.ciarem.ai/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"sub_origin_id": "<string>",
"sub_origin_key": "<string>",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"properties": {}
}
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({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone: '<string>',
country: '<string>',
city: '<string>',
instagram: '<string>',
sub_origin_id: '<string>',
sub_origin_key: '<string>',
funnel_stage_id: '<string>',
owner_id: '<string>',
properties: {}
})
};
fetch('https://api.ciarem.ai/v1/contacts', 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://api.ciarem.ai/v1/contacts",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'country' => '<string>',
'city' => '<string>',
'instagram' => '<string>',
'sub_origin_id' => '<string>',
'sub_origin_key' => '<string>',
'funnel_stage_id' => '<string>',
'owner_id' => '<string>',
'properties' => [
]
]),
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://api.ciarem.ai/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\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://api.ciarem.ai/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/contacts")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"messenger": "<string>",
"whatsapp_username": "<string>",
"origin": "SOCIAL",
"sub_origin_id": "<string>",
"whatsapp_status": "verified",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"last_contacted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"properties": {}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": {
"field": "email",
"conflicting_contact_id": "<string>",
"code": "duplicate_contact",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"instagram": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}Create a contact
curl --request POST \
--url https://api.ciarem.ai/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"sub_origin_id": "<string>",
"sub_origin_key": "<string>",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"properties": {}
}
'import requests
url = "https://api.ciarem.ai/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"sub_origin_id": "<string>",
"sub_origin_key": "<string>",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"properties": {}
}
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({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone: '<string>',
country: '<string>',
city: '<string>',
instagram: '<string>',
sub_origin_id: '<string>',
sub_origin_key: '<string>',
funnel_stage_id: '<string>',
owner_id: '<string>',
properties: {}
})
};
fetch('https://api.ciarem.ai/v1/contacts', 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://api.ciarem.ai/v1/contacts",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'country' => '<string>',
'city' => '<string>',
'instagram' => '<string>',
'sub_origin_id' => '<string>',
'sub_origin_key' => '<string>',
'funnel_stage_id' => '<string>',
'owner_id' => '<string>',
'properties' => [
]
]),
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://api.ciarem.ai/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\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://api.ciarem.ai/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/contacts")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"city\": \"<string>\",\n \"instagram\": \"<string>\",\n \"sub_origin_id\": \"<string>\",\n \"sub_origin_key\": \"<string>\",\n \"funnel_stage_id\": \"<string>\",\n \"owner_id\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"city": "<string>",
"instagram": "<string>",
"messenger": "<string>",
"whatsapp_username": "<string>",
"origin": "SOCIAL",
"sub_origin_id": "<string>",
"whatsapp_status": "verified",
"funnel_stage_id": "<string>",
"owner_id": "<string>",
"last_contacted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"properties": {}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": {
"field": "email",
"conflicting_contact_id": "<string>",
"code": "duplicate_contact",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"instagram": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}Authorizations
An org API key: Authorization: Bearer oak_….
Body
^\+[1-9]\d{1,14}$^[A-Z]{2}$1 - 120^[a-zA-Z0-9._]{1,30}$Top-level acquisition category — how a contact entered the CRM.
Set once at first touch and never overwritten: a contact who joins the
waitlist (WEB) and later messages on WhatsApp keeps WEB; the channel
they messaged on lives on their ContactHandle, not here. The category is
a fixed, platform-owned vocabulary so analytics roll-ups, the AI prompt,
and inbound auto-assignment stay stable across orgs. The specific named
source within a category (e.g. "Waitlist", "SaaStr 2026", "WhatsApp") is
org-customizable — see the contact_sub_origins table. NULL for legacy
contacts whose origin predates this field. Replaces the old conversational-
only ContactSource (WHATSAPP/INSTAGRAM/MESSENGER), which collapsed
acquisition and channel into one field.
SOCIAL, ADS, WEB, EVENT, REFERRAL, OUTBOUND, IMPORT, MANUAL, API, OTHER Show child attributes
Show child attributes
Response
Successful Response
Top-level acquisition category — how a contact entered the CRM.
Set once at first touch and never overwritten: a contact who joins the
waitlist (WEB) and later messages on WhatsApp keeps WEB; the channel
they messaged on lives on their ContactHandle, not here. The category is
a fixed, platform-owned vocabulary so analytics roll-ups, the AI prompt,
and inbound auto-assignment stay stable across orgs. The specific named
source within a category (e.g. "Waitlist", "SaaStr 2026", "WhatsApp") is
org-customizable — see the contact_sub_origins table. NULL for legacy
contacts whose origin predates this field. Replaces the old conversational-
only ContactSource (WHATSAPP/INSTAGRAM/MESSENGER), which collapsed
acquisition and channel into one field.
SOCIAL, ADS, WEB, EVENT, REFERRAL, OUTBOUND, IMPORT, MANUAL, API, OTHER WhatsApp presence status for a contact's phone number.
A new contact starts as UNVERIFIED when a phone is on file or
UNAVAILABLE when none is. The AI agent flips UNVERIFIED →
VERIFIED on a successful send, or → UNAVAILABLE on a 404 /
not-on-whatsapp response. Direct patching is not exposed; the
write path is purely service-layer derivation.
verified, unverified, unavailable Show child attributes
Show child attributes