curl --request POST \
--url https://{subdomain}.conveyour.com/api/analytics/identify \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"id": "jane@example.com",
"traits": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com"
}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'jane@example.com',
traits: {first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com'}
})
};
fetch('https://{subdomain}.conveyour.com/api/analytics/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'jane@example.com',
traits: {first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com'}
})
};
fetch('https://{subdomain}.conveyour.com/api/analytics/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/analytics/identify"
payload = {
"id": "jane@example.com",
"traits": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com"
}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/analytics/identify",
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([
'id' => 'jane@example.com',
'traits' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jane@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "queued",
"data": {}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Identify a contact
Associates a visitor or known contact with a set of traits. Use this to create or update a contact record from the browser — for example, after a form submission or login event.
Create or update a contact from the browser (async or sync)
curl --request POST \
--url https://{subdomain}.conveyour.com/api/analytics/identify \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"id": "jane@example.com",
"traits": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com"
}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'jane@example.com',
traits: {first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com'}
})
};
fetch('https://{subdomain}.conveyour.com/api/analytics/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'jane@example.com',
traits: {first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com'}
})
};
fetch('https://{subdomain}.conveyour.com/api/analytics/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/analytics/identify"
payload = {
"id": "jane@example.com",
"traits": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com"
}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/analytics/identify",
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([
'id' => 'jane@example.com',
'traits' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jane@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "queued",
"data": {}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
The contact identifier — email address, phone number, public portal ID (PID), or internal contact ID.
Contact fields to create or update (e.g. first_name, last_name, mobile, any org-defined field). Pass "$process": 2 inside traits for synchronous processing (see response section).
Response
Success.
The common response envelope shared by all ConveYour endpoints.
ok on success, failed on error.
ok, failed Human-readable description of the result.
Empty for a batch (array) payload — that path returns [] with message "queued N". Also empty for a single payload unless traits.$process = 2.
Show child attributes
Show child attributes