Create a contact
curl --request POST \
--url https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact": {
"contactId": "external-contact-123",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"tags": [
"historical-import"
],
"secondaryEmails": [
"jane.alt@example.com"
]
}
}
'import requests
url = "https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts"
payload = { "contact": {
"contactId": "external-contact-123",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"tags": ["historical-import"],
"secondaryEmails": ["jane.alt@example.com"]
} }
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({
contact: {
contactId: 'external-contact-123',
email: 'jane@example.com',
firstName: 'Jane',
lastName: 'Doe',
tags: ['historical-import'],
secondaryEmails: ['jane.alt@example.com']
}
})
};
fetch('https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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([
'contact' => [
'contactId' => 'external-contact-123',
'email' => 'jane@example.com',
'firstName' => 'Jane',
'lastName' => 'Doe',
'tags' => [
'historical-import'
],
'secondaryEmails' => [
'jane.alt@example.com'
]
]
]),
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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts"
payload := strings.NewReader("{\n \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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 \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"contactId": "external-contact-123",
"result": "created"
}
}Contacts
Create a contact
Create one contact without updating or merging an existing record. Requires cxm:contacts.write. At least one primary email or phone is required; secondary addresses alone are insufficient. Checks all supplied primary and secondary identities against stored primary and secondary values and returns one blocking contact ID. ID conflicts take precedence. IDs and primary emails have database uniqueness protection; concurrent phone/secondary conflicts may escape lookup checks. Deduplicate and serialize overlapping identities. Requires the matching tenant API-key write scope or broader scope. Maximum JSON request body: 1 MiB, subject to a lower configured gateway limit. Unknown fields are rejected. Each accepted request executes; no idempotency or replay guarantee. A timeout may occur after commit.
POST
/
api
/
v1
/
cxm
/
tenants
/
{tenantId}
/
contacts
Create a contact
curl --request POST \
--url https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact": {
"contactId": "external-contact-123",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"tags": [
"historical-import"
],
"secondaryEmails": [
"jane.alt@example.com"
]
}
}
'import requests
url = "https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts"
payload = { "contact": {
"contactId": "external-contact-123",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"tags": ["historical-import"],
"secondaryEmails": ["jane.alt@example.com"]
} }
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({
contact: {
contactId: 'external-contact-123',
email: 'jane@example.com',
firstName: 'Jane',
lastName: 'Doe',
tags: ['historical-import'],
secondaryEmails: ['jane.alt@example.com']
}
})
};
fetch('https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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([
'contact' => [
'contactId' => 'external-contact-123',
'email' => 'jane@example.com',
'firstName' => 'Jane',
'lastName' => 'Doe',
'tags' => [
'historical-import'
],
'secondaryEmails' => [
'jane.alt@example.com'
]
]
]),
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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts"
payload := strings.NewReader("{\n \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\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://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.crescendo.ai/api/v1/cxm/tenants/{tenantId}/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 \"contact\": {\n \"contactId\": \"external-contact-123\",\n \"email\": \"jane@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"tags\": [\n \"historical-import\"\n ],\n \"secondaryEmails\": [\n \"jane.alt@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"contactId": "external-contact-123",
"result": "created"
}
}Authorizations
Tenant API key with the operation's scope: cxm:conversations.read, cxm:conversations.write, cxm:contacts.write, or cxm:organizations.write. Corresponding resource wildcards and broader cxm:read, cxm:write, or cxm:* scopes apply. Keep it in a trusted backend; do not expose it in browser code.
Path Parameters
Tenant authorized for the API key and every referenced resource.
Required string length:
1 - 255Body
application/json
Create-only contact fields. Secondary addresses alone cannot satisfy the required primary email or phone. No organization, custom fields or historical timestamps.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Contact created.
Show child attributes
Show child attributes