Contacts
Create or upsert a contact
Create a CRM contact. With no id and a matching email, the existing contact is updated instead of duplicated (upsert). Fires the contact_created / contact_updated automation events. Requires scope contacts:write. Send list_source to say where the contact came from: it marks a new contact and runs a free email check on it.
POST
/
contacts
Create or upsert a contact
curl --request POST \
--url https://api.smartlyq.com/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"company": "<string>",
"role": "<string>",
"timezone": "<string>",
"language": "<string>",
"source": "<string>",
"address1": "12 Ermou St",
"city": "Athens",
"state": "Attica",
"postal_code": "10563",
"country": "GR",
"date_of_birth": "1985-03-14",
"website": "https://example.com",
"tags": [
"<string>"
],
"attributes": {},
"list_consent": true
}
'import requests
url = "https://api.smartlyq.com/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"company": "<string>",
"role": "<string>",
"timezone": "<string>",
"language": "<string>",
"source": "<string>",
"address1": "12 Ermou St",
"city": "Athens",
"state": "Attica",
"postal_code": "10563",
"country": "GR",
"date_of_birth": "1985-03-14",
"website": "https://example.com",
"tags": ["<string>"],
"attributes": {},
"list_consent": True
}
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>',
name: '<string>',
email: '[email protected]',
phone: '<string>',
company: '<string>',
role: '<string>',
timezone: '<string>',
language: '<string>',
source: '<string>',
address1: '12 Ermou St',
city: 'Athens',
state: 'Attica',
postal_code: '10563',
country: 'GR',
date_of_birth: '1985-03-14',
website: 'https://example.com',
tags: ['<string>'],
attributes: {},
list_consent: true
})
};
fetch('https://api.smartlyq.com/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.smartlyq.com/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>',
'name' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'company' => '<string>',
'role' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'source' => '<string>',
'address1' => '12 Ermou St',
'city' => 'Athens',
'state' => 'Attica',
'postal_code' => '10563',
'country' => 'GR',
'date_of_birth' => '1985-03-14',
'website' => 'https://example.com',
'tags' => [
'<string>'
],
'attributes' => [
],
'list_consent' => true
]),
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.smartlyq.com/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\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.smartlyq.com/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smartlyq.com/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 \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 8412,
"name": "Ada Lovelace",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"phone": "+30 694 123 4567",
"company": "Acme Corp",
"role": "Head of Growth",
"status": "customer",
"tags": [
"vip",
"newsletter"
],
"attributes": {
"lead_source": "webinar"
},
"source": "api",
"created_at": "2026-07-01T10:15:00Z",
"updated_at": "2026-07-26T09:41:22Z",
"matched_by": "email"
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": true,
"data": {
"id": 8412,
"name": "Ada Lovelace",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"phone": "+30 694 123 4567",
"company": "Acme Corp",
"role": "Head of Growth",
"status": "customer",
"tags": [
"vip",
"newsletter"
],
"attributes": {
"lead_source": "webinar"
},
"source": "api",
"created_at": "2026-07-01T10:15:00Z",
"updated_at": "2026-07-26T09:41:22Z",
"matched_by": null
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Missing or malformed Authorization header",
"details": {}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "API key lacks required scope: social:write",
"details": {
"required_scope": "social:write"
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Missing required fields: content, platforms.",
"details": {
"fields": [
"content",
"platforms"
]
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}Authorizations
API key from Developer dashboard (Bearer token).
Body
application/json
Full name; derived from first/last when those are sent.
Available options:
active, prospect, in_progress, lost Street line.
Maximum string length:
255Example:
"12 Ermou St"
Maximum string length:
100Example:
"Athens"
State, region or province.
Maximum string length:
100Example:
"Attica"
Text, not a number - leading zeros and letters are kept ("02134", "SW1A 1AA").
Maximum string length:
20Example:
"10563"
ISO 3166-1 alpha-2 code ("GR") or an English country name ("Greece"); stored and returned as the code. An unknown country is a 422.
Example:
"GR"
YYYY-MM-DD (DD/MM/YYYY also accepted). A real past date after 1900; anything else is a 422.
Example:
"1985-03-14"
A bare domain gets https:// added.
Maximum string length:
500Example:
"https://example.com"
Custom attribute values keyed by attribute key.
Optional. Where these contacts came from. Leave it out and the contact is not marked (as before). bought, found_online and lead_finder make the contact outreach only: it is never emailed through the built-in email service, only through your own mail server. own_customers and events need list_consent: true. Every email also gets a free check (format, throwaway domains, domains that accept no mail, your suppression list); an invalid address is never emailed.
Available options:
own_customers, events, bought, found_online, lead_finder Required as true when list_source is own_customers or events: these people agreed to receive email from you. Ignored for the other sources.
⌘I
Create or upsert a contact
curl --request POST \
--url https://api.smartlyq.com/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"company": "<string>",
"role": "<string>",
"timezone": "<string>",
"language": "<string>",
"source": "<string>",
"address1": "12 Ermou St",
"city": "Athens",
"state": "Attica",
"postal_code": "10563",
"country": "GR",
"date_of_birth": "1985-03-14",
"website": "https://example.com",
"tags": [
"<string>"
],
"attributes": {},
"list_consent": true
}
'import requests
url = "https://api.smartlyq.com/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"company": "<string>",
"role": "<string>",
"timezone": "<string>",
"language": "<string>",
"source": "<string>",
"address1": "12 Ermou St",
"city": "Athens",
"state": "Attica",
"postal_code": "10563",
"country": "GR",
"date_of_birth": "1985-03-14",
"website": "https://example.com",
"tags": ["<string>"],
"attributes": {},
"list_consent": True
}
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>',
name: '<string>',
email: '[email protected]',
phone: '<string>',
company: '<string>',
role: '<string>',
timezone: '<string>',
language: '<string>',
source: '<string>',
address1: '12 Ermou St',
city: 'Athens',
state: 'Attica',
postal_code: '10563',
country: 'GR',
date_of_birth: '1985-03-14',
website: 'https://example.com',
tags: ['<string>'],
attributes: {},
list_consent: true
})
};
fetch('https://api.smartlyq.com/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.smartlyq.com/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>',
'name' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'company' => '<string>',
'role' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'source' => '<string>',
'address1' => '12 Ermou St',
'city' => 'Athens',
'state' => 'Attica',
'postal_code' => '10563',
'country' => 'GR',
'date_of_birth' => '1985-03-14',
'website' => 'https://example.com',
'tags' => [
'<string>'
],
'attributes' => [
],
'list_consent' => true
]),
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.smartlyq.com/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\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.smartlyq.com/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smartlyq.com/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 \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"company\": \"<string>\",\n \"role\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"source\": \"<string>\",\n \"address1\": \"12 Ermou St\",\n \"city\": \"Athens\",\n \"state\": \"Attica\",\n \"postal_code\": \"10563\",\n \"country\": \"GR\",\n \"date_of_birth\": \"1985-03-14\",\n \"website\": \"https://example.com\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {},\n \"list_consent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 8412,
"name": "Ada Lovelace",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"phone": "+30 694 123 4567",
"company": "Acme Corp",
"role": "Head of Growth",
"status": "customer",
"tags": [
"vip",
"newsletter"
],
"attributes": {
"lead_source": "webinar"
},
"source": "api",
"created_at": "2026-07-01T10:15:00Z",
"updated_at": "2026-07-26T09:41:22Z",
"matched_by": "email"
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": true,
"data": {
"id": 8412,
"name": "Ada Lovelace",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"phone": "+30 694 123 4567",
"company": "Acme Corp",
"role": "Head of Growth",
"status": "customer",
"tags": [
"vip",
"newsletter"
],
"attributes": {
"lead_source": "webinar"
},
"source": "api",
"created_at": "2026-07-01T10:15:00Z",
"updated_at": "2026-07-26T09:41:22Z",
"matched_by": null
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Missing or malformed Authorization header",
"details": {}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "API key lacks required scope: social:write",
"details": {
"required_scope": "social:write"
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Missing required fields: content, platforms.",
"details": {
"fields": [
"content",
"platforms"
]
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}