Create a new contact
curl --request POST \
--url https://api.cleartalk.ai/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
'import requests
url = "https://api.cleartalk.ai/contacts"
payload = {
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listName: '<string>',
tag: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
dateOfBirth: '<string>',
contactSource: '<string>',
clearTalkNotes: '<string>',
customField: {}
})
};
fetch('https://api.cleartalk.ai/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.cleartalk.ai/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([
'listName' => '<string>',
'tag' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'dateOfBirth' => '<string>',
'contactSource' => '<string>',
'clearTalkNotes' => '<string>',
'customField' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api.cleartalk.ai/contacts"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.cleartalk.ai/contacts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"userId": 123,
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Contacts
Create a new contact
POST
/
contacts
Create a new contact
curl --request POST \
--url https://api.cleartalk.ai/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
'import requests
url = "https://api.cleartalk.ai/contacts"
payload = {
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listName: '<string>',
tag: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
dateOfBirth: '<string>',
contactSource: '<string>',
clearTalkNotes: '<string>',
customField: {}
})
};
fetch('https://api.cleartalk.ai/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.cleartalk.ai/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([
'listName' => '<string>',
'tag' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'dateOfBirth' => '<string>',
'contactSource' => '<string>',
'clearTalkNotes' => '<string>',
'customField' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api.cleartalk.ai/contacts"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.cleartalk.ai/contacts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"tag\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"contactSource\": \"<string>\",\n \"clearTalkNotes\": \"<string>\",\n \"customField\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"userId": 123,
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
API Key for authentication
Body
application/json
List name for the contact
Tag for the contact
First name of the contact
Last name of the contact
Email of the contact
Phone number of the contact
Date of birth of the contact
Source of the contact
Notes for the contact
Custom fields for the contact
Response
201 - application/json
Contact created successfully
Contact ID
User ID
List name for the contact
Tag for the contact
First name of the contact
Last name of the contact
Email of the contact
Phone number of the contact
Date of birth of the contact
Source of the contact
Notes for the contact
Custom fields for the contact
Creation date
Last update date
⌘I
