Create a contact
curl --request POST \
--url https://us.api.hellotars.com/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"tags": [
"<string>"
]
}
'import requests
url = "https://us.api.hellotars.com/api/v1/contacts"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"tags": ["<string>"]
}
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({
name: '<string>',
email: '<string>',
phone: '<string>',
channelIdentifiers: {web: '<string>', whatsapp: {phone: '<string>', bsuid: '<string>'}},
tags: ['<string>']
})
};
fetch('https://us.api.hellotars.com/api/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://us.api.hellotars.com/api/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([
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'channelIdentifiers' => [
'web' => '<string>',
'whatsapp' => [
'phone' => '<string>',
'bsuid' => '<string>'
]
],
'tags' => [
'<string>'
]
]),
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://us.api.hellotars.com/api/v1/contacts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\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://us.api.hellotars.com/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/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 \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tags": [
"<string>"
],
"origin": "inbound",
"createdAt": 123,
"lastSeenAt": 123,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"consent": {}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}Contacts
Create a contact
Create a reachable end-user record with normalized email and phone details.
POST
/
api
/
v1
/
contacts
Create a contact
curl --request POST \
--url https://us.api.hellotars.com/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"tags": [
"<string>"
]
}
'import requests
url = "https://us.api.hellotars.com/api/v1/contacts"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"tags": ["<string>"]
}
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({
name: '<string>',
email: '<string>',
phone: '<string>',
channelIdentifiers: {web: '<string>', whatsapp: {phone: '<string>', bsuid: '<string>'}},
tags: ['<string>']
})
};
fetch('https://us.api.hellotars.com/api/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://us.api.hellotars.com/api/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([
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'channelIdentifiers' => [
'web' => '<string>',
'whatsapp' => [
'phone' => '<string>',
'bsuid' => '<string>'
]
],
'tags' => [
'<string>'
]
]),
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://us.api.hellotars.com/api/v1/contacts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\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://us.api.hellotars.com/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/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 \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"channelIdentifiers\": {\n \"web\": \"<string>\",\n \"whatsapp\": {\n \"phone\": \"<string>\",\n \"bsuid\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tags": [
"<string>"
],
"origin": "inbound",
"createdAt": 123,
"lastSeenAt": 123,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"channelIdentifiers": {
"web": "<string>",
"whatsapp": {
"phone": "<string>",
"bsuid": "<string>"
}
},
"consent": {}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}A duplicate email or phone returns a 409 contact_exists problem with field and contactId. Supply an email, phone or channel identifier.
Related pages
Authorizations
An API key (tars_sk_…) sent as Authorization: Bearer <key>. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.
Body
application/json
A new contact. It needs an email, a phone or a channel identifier.
Response
The new contact.
A contact in your organization.
The contact id.
How the contact was created: inbound from a conversation, imported from a file, manual by hand or over this API, outbound_call when a voice agent called the number.
Available options:
inbound, imported, manual, outbound_call When the contact was created, in milliseconds since the epoch.
When the contact was last active, in milliseconds since the epoch.
Email address, normalized.
Phone number in E.164 format.
Where Tars can reach the contact on each channel. Only the channels Tars has seen are present.
Show child attributes
Show child attributes
Consent per channel, keyed by channel name such as web or whatsapp.
Show child attributes
Show child attributes
⌘I