curl --request POST \
--url https://core-api.getaptly.com/api/contacts \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"firstname": "Jane",
"lastname": "Smith",
"email": "[email protected]",
"phone": [
{
"number": "+15555550100",
"type": "mobile"
}
],
"contactType": "Tenant"
}
'import requests
url = "https://core-api.getaptly.com/api/contacts"
payload = {
"firstname": "Jane",
"lastname": "Smith",
"email": "[email protected]",
"phone": [
{
"number": "+15555550100",
"type": "mobile"
}
],
"contactType": "Tenant"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstname: 'Jane',
lastname: 'Smith',
email: '[email protected]',
phone: [{number: '+15555550100', type: 'mobile'}],
contactType: 'Tenant'
})
};
fetch('https://core-api.getaptly.com/api/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://core-api.getaptly.com/api/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([
'firstname' => 'Jane',
'lastname' => 'Smith',
'email' => '[email protected]',
'phone' => [
[
'number' => '+15555550100',
'type' => 'mobile'
]
],
'contactType' => 'Tenant'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/contacts"
payload := strings.NewReader("{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
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://core-api.getaptly.com/api/contacts")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"uuid": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"fullName": "<string>",
"duogram": "<string>",
"photoId": "<string>",
"imageUrl": "<string>",
"email": "<string>",
"phone": "<string>",
"typeId": "<string>",
"companyId": "<string>",
"address": {},
"title": "<string>",
"alerts": [
{}
],
"company": "<string>",
"isCompany": true
}{
"error": "<string>",
"message": "<string>"
}Create or update a contact
Creates a new contact or updates an existing one (upsert).
Lookup order:
- If
_idis provided, finds by ID. - Otherwise finds by first email address.
- If no match is found, creates a new contact.
Body formats — either native or legacy (capitalized keys) are accepted:
Native: firstname, lastname, email (string or array), phone (array of {number, type}),
typeId, contactType, isCompany, title, company, imageUrl, customFields
Legacy: "First Name", "Last Name", Email, "Mobile Phone", "Work Phone",
"Home Phone", "Contact Type", Title, Company
Returns the enriched contact with custom fields populated by their type definitions.
curl --request POST \
--url https://core-api.getaptly.com/api/contacts \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"firstname": "Jane",
"lastname": "Smith",
"email": "[email protected]",
"phone": [
{
"number": "+15555550100",
"type": "mobile"
}
],
"contactType": "Tenant"
}
'import requests
url = "https://core-api.getaptly.com/api/contacts"
payload = {
"firstname": "Jane",
"lastname": "Smith",
"email": "[email protected]",
"phone": [
{
"number": "+15555550100",
"type": "mobile"
}
],
"contactType": "Tenant"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstname: 'Jane',
lastname: 'Smith',
email: '[email protected]',
phone: [{number: '+15555550100', type: 'mobile'}],
contactType: 'Tenant'
})
};
fetch('https://core-api.getaptly.com/api/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://core-api.getaptly.com/api/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([
'firstname' => 'Jane',
'lastname' => 'Smith',
'email' => '[email protected]',
'phone' => [
[
'number' => '+15555550100',
'type' => 'mobile'
]
],
'contactType' => 'Tenant'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/contacts"
payload := strings.NewReader("{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
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://core-api.getaptly.com/api/contacts")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstname\": \"Jane\",\n \"lastname\": \"Smith\",\n \"email\": \"[email protected]\",\n \"phone\": [\n {\n \"number\": \"+15555550100\",\n \"type\": \"mobile\"\n }\n ],\n \"contactType\": \"Tenant\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"uuid": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"fullName": "<string>",
"duogram": "<string>",
"photoId": "<string>",
"imageUrl": "<string>",
"email": "<string>",
"phone": "<string>",
"typeId": "<string>",
"companyId": "<string>",
"address": {},
"title": "<string>",
"alerts": [
{}
],
"company": "<string>",
"isCompany": true
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Body
Existing contact ID — when provided, updates that contact.
One or more email addresses.
Show child attributes
Show child attributes
Contact type ID.
Contact type name (alternative to typeId — resolved to an ID automatically).
Absolute URL to a JPG or PNG photo.
Map of custom field ID to value. Unknown field IDs are rejected.
Response
Contact created or updated.
MongoDB ObjectId of the contact.
Computed display name (first + last, or company name for org records).
Two-letter initials derived from first and last name.
CDN thumbnail URL for the contact's photo, or null if none.
Company name — populated when isCompany is true.