Batch-create end users
curl --request POST \
--url https://us.api.hellotars.com/api/endusers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endUsers": [
{
"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/endusers/batch"
payload = { "endUsers": [
{
"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({
endUsers: [
{
name: '<string>',
email: '<string>',
phone: '<string>',
channelIdentifiers: {web: '<string>', whatsapp: {phone: '<string>', bsuid: '<string>'}},
tags: ['<string>']
}
]
})
};
fetch('https://us.api.hellotars.com/api/endusers/batch', 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/endusers/batch",
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([
'endUsers' => [
[
'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/endusers/batch"
payload := strings.NewReader("{\n \"endUsers\": [\n {\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 }\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/endusers/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endUsers\": [\n {\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 }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/endusers/batch")
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 \"endUsers\": [\n {\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 }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 48,
"skipped": 2,
"errors": [{ "index": 7, "reason": "duplicate email" }]
}
End users
Batch-create end users
Create up to 50 end-user records in one request and get per-row results with skipped duplicates.
POST
/
api
/
endusers
/
batch
Batch-create end users
curl --request POST \
--url https://us.api.hellotars.com/api/endusers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endUsers": [
{
"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/endusers/batch"
payload = { "endUsers": [
{
"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({
endUsers: [
{
name: '<string>',
email: '<string>',
phone: '<string>',
channelIdentifiers: {web: '<string>', whatsapp: {phone: '<string>', bsuid: '<string>'}},
tags: ['<string>']
}
]
})
};
fetch('https://us.api.hellotars.com/api/endusers/batch', 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/endusers/batch",
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([
'endUsers' => [
[
'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/endusers/batch"
payload := strings.NewReader("{\n \"endUsers\": [\n {\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 }\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/endusers/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endUsers\": [\n {\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 }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/endusers/batch")
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 \"endUsers\": [\n {\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 }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 48,
"skipped": 2,
"errors": [{ "index": 7, "reason": "duplicate email" }]
}
A batch never fails because of one duplicate row. Tars checks each entry’s email and phone against earlier entries in the same request and against existing records. A match is skipped, and the rest of the batch is still created.
Requires a key with the End-users permission. See API authentication.
object[]
required
At most 50 entries. Each entry uses the create fields and needs an
origin.Response
The response reports per-row results.number
Count of records created.
number
Count of entries skipped as duplicates.
object[]
One entry per skipped row, with its
index in the batch and a reason.{
"created": 48,
"skipped": 2,
"errors": [{ "index": 7, "reason": "duplicate email" }]
}
Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | Malformed body, an empty or missing endUsers array, over 50 entries, or an entry with an unknown or missing origin |
401 | UNAUTHORIZED | Missing, invalid, or revoked key |
403 | FORBIDDEN | Key lacks the End-users permission |
Authorizations
API key sent as Authorization: Bearer YOUR_API_KEY. Campaign endpoints use campaign-scoped keys; the rest use organization or agent keys with the matching permission.
Body
application/json
The records to create, up to 50 per request. Each row is reported separately, so a duplicate skips that row without failing the call.
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
Batch result; duplicates are skipped, not failed
⌘I
