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.
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>",
"tags": [
"<string>"
],
"attributes": {}
}
'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>",
"tags": ["<string>"],
"attributes": {}
}
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>',
tags: ['<string>'],
attributes: {}
})
};
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>',
'tags' => [
'<string>'
],
'attributes' => [
]
]),
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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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, inactive Custom attribute values keyed by attribute key.
Previous
Bulk import contactsImport up to 100 contacts in one call. Each row goes through the same email/phone upsert as POST /contacts, so re-importing the same file is idempotent. Per-row results report created / updated / failed. Requires scope `contacts:write`.
Next
⌘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>",
"tags": [
"<string>"
],
"attributes": {}
}
'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>",
"tags": ["<string>"],
"attributes": {}
}
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>',
tags: ['<string>'],
attributes: {}
})
};
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>',
'tags' => [
'<string>'
],
'attributes' => [
]
]),
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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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 \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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"
}
}