Add new customers in bulk. Also creates new profile if a customer does not exist yet.
curl --request POST \
--url https://{tenant_domain}/third-party/v1/customers/bulk-import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{
"channel": "whatsapp",
"display_id": 491521234567,
"name": "<string>",
"profile": {
"email": "<string>",
"date_of_birth": "<string>",
"address": "<string>",
"custom_1": "<string>",
"custom_2": "<string>",
"custom_3": "<string>",
"custom_4": "<string>",
"custom_5": "<string>",
"marketing_opt_in": 1,
"tags": "<string>"
}
}
]
}
'import requests
url = "https://{tenant_domain}/third-party/v1/customers/bulk-import"
payload = { "customers": [
{
"channel": "whatsapp",
"display_id": 491521234567,
"name": "<string>",
"profile": {
"email": "<string>",
"date_of_birth": "<string>",
"address": "<string>",
"custom_1": "<string>",
"custom_2": "<string>",
"custom_3": "<string>",
"custom_4": "<string>",
"custom_5": "<string>",
"marketing_opt_in": 1,
"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({
customers: [
{
channel: 'whatsapp',
display_id: 491521234567,
name: '<string>',
profile: {
email: '<string>',
date_of_birth: '<string>',
address: '<string>',
custom_1: '<string>',
custom_2: '<string>',
custom_3: '<string>',
custom_4: '<string>',
custom_5: '<string>',
marketing_opt_in: 1,
tags: '<string>'
}
}
]
})
};
fetch('https://{tenant_domain}/third-party/v1/customers/bulk-import', 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://{tenant_domain}/third-party/v1/customers/bulk-import",
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([
'customers' => [
[
'channel' => 'whatsapp',
'display_id' => 491521234567,
'name' => '<string>',
'profile' => [
'email' => '<string>',
'date_of_birth' => '<string>',
'address' => '<string>',
'custom_1' => '<string>',
'custom_2' => '<string>',
'custom_3' => '<string>',
'custom_4' => '<string>',
'custom_5' => '<string>',
'marketing_opt_in' => 1,
'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://{tenant_domain}/third-party/v1/customers/bulk-import"
payload := strings.NewReader("{\n \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<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://{tenant_domain}/third-party/v1/customers/bulk-import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant_domain}/third-party/v1/customers/bulk-import")
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 \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_count": 123,
"updated_count": 123,
"skipped_count": 123
}
}customers
Add new customers in bulk. Also creates new profile if a customer does not exist yet.
Currently only possible for channel WhatsApp.
POST
/
customers
/
bulk-import
Add new customers in bulk. Also creates new profile if a customer does not exist yet.
curl --request POST \
--url https://{tenant_domain}/third-party/v1/customers/bulk-import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{
"channel": "whatsapp",
"display_id": 491521234567,
"name": "<string>",
"profile": {
"email": "<string>",
"date_of_birth": "<string>",
"address": "<string>",
"custom_1": "<string>",
"custom_2": "<string>",
"custom_3": "<string>",
"custom_4": "<string>",
"custom_5": "<string>",
"marketing_opt_in": 1,
"tags": "<string>"
}
}
]
}
'import requests
url = "https://{tenant_domain}/third-party/v1/customers/bulk-import"
payload = { "customers": [
{
"channel": "whatsapp",
"display_id": 491521234567,
"name": "<string>",
"profile": {
"email": "<string>",
"date_of_birth": "<string>",
"address": "<string>",
"custom_1": "<string>",
"custom_2": "<string>",
"custom_3": "<string>",
"custom_4": "<string>",
"custom_5": "<string>",
"marketing_opt_in": 1,
"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({
customers: [
{
channel: 'whatsapp',
display_id: 491521234567,
name: '<string>',
profile: {
email: '<string>',
date_of_birth: '<string>',
address: '<string>',
custom_1: '<string>',
custom_2: '<string>',
custom_3: '<string>',
custom_4: '<string>',
custom_5: '<string>',
marketing_opt_in: 1,
tags: '<string>'
}
}
]
})
};
fetch('https://{tenant_domain}/third-party/v1/customers/bulk-import', 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://{tenant_domain}/third-party/v1/customers/bulk-import",
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([
'customers' => [
[
'channel' => 'whatsapp',
'display_id' => 491521234567,
'name' => '<string>',
'profile' => [
'email' => '<string>',
'date_of_birth' => '<string>',
'address' => '<string>',
'custom_1' => '<string>',
'custom_2' => '<string>',
'custom_3' => '<string>',
'custom_4' => '<string>',
'custom_5' => '<string>',
'marketing_opt_in' => 1,
'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://{tenant_domain}/third-party/v1/customers/bulk-import"
payload := strings.NewReader("{\n \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<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://{tenant_domain}/third-party/v1/customers/bulk-import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant_domain}/third-party/v1/customers/bulk-import")
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 \"customers\": [\n {\n \"channel\": \"whatsapp\",\n \"display_id\": 491521234567,\n \"name\": \"<string>\",\n \"profile\": {\n \"email\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_1\": \"<string>\",\n \"custom_2\": \"<string>\",\n \"custom_3\": \"<string>\",\n \"custom_4\": \"<string>\",\n \"custom_5\": \"<string>\",\n \"marketing_opt_in\": 1,\n \"tags\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_count": 123,
"updated_count": 123,
"skipped_count": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200 - application/json
Success
Show child attributes
Show child attributes
⌘I