cURL
curl --request PUT \
--url https://campaigns.pingmee.co.il/customers \
--header 'Content-Type: application/json' \
--header 'Cookie: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
[
{
"customerName": "<string>",
"phoneNumberId": "<string>",
"profileImage": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
}
]
'import requests
url = "https://campaigns.pingmee.co.il/customers"
payload = [
{
"customerName": "<string>",
"phoneNumberId": "<string>",
"profileImage": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
}
]
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
customerName: '<string>',
phoneNumberId: '<string>',
profileImage: '<string>',
customerNickname: '<string>',
description: '<string>',
email: 'jsmith@example.com'
}
])
};
fetch('https://campaigns.pingmee.co.il/customers', 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://campaigns.pingmee.co.il/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'customerName' => '<string>',
'phoneNumberId' => '<string>',
'profileImage' => '<string>',
'customerNickname' => '<string>',
'description' => '<string>',
'email' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"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://campaigns.pingmee.co.il/customers"
payload := strings.NewReader("[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Cookie", "<api-key>")
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.put("https://campaigns.pingmee.co.il/customers")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.pingmee.co.il/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]"
response = http.request(request)
puts response.read_body{
"customers": [
{
"profileImage": "<string>",
"customerName": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"createdAt": 123,
"lastActiveAt": 123,
"email": "jsmith@example.com",
"platform": "whatsapp",
"phoneNumberId": "<string>",
"countryCode": "<string>",
"associatedTo": "<string>",
"parsedPhoneNumber": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>"
}Customers
Create Customers
Creates one or more customers.
PUT
/
customers
cURL
curl --request PUT \
--url https://campaigns.pingmee.co.il/customers \
--header 'Content-Type: application/json' \
--header 'Cookie: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
[
{
"customerName": "<string>",
"phoneNumberId": "<string>",
"profileImage": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
}
]
'import requests
url = "https://campaigns.pingmee.co.il/customers"
payload = [
{
"customerName": "<string>",
"phoneNumberId": "<string>",
"profileImage": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
}
]
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
customerName: '<string>',
phoneNumberId: '<string>',
profileImage: '<string>',
customerNickname: '<string>',
description: '<string>',
email: 'jsmith@example.com'
}
])
};
fetch('https://campaigns.pingmee.co.il/customers', 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://campaigns.pingmee.co.il/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'customerName' => '<string>',
'phoneNumberId' => '<string>',
'profileImage' => '<string>',
'customerNickname' => '<string>',
'description' => '<string>',
'email' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"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://campaigns.pingmee.co.il/customers"
payload := strings.NewReader("[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Cookie", "<api-key>")
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.put("https://campaigns.pingmee.co.il/customers")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.pingmee.co.il/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"customerName\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"profileImage\": \"<string>\",\n \"customerNickname\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n]"
response = http.request(request)
puts response.read_body{
"customers": [
{
"profileImage": "<string>",
"customerName": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"createdAt": 123,
"lastActiveAt": 123,
"email": "jsmith@example.com",
"platform": "whatsapp",
"phoneNumberId": "<string>",
"countryCode": "<string>",
"associatedTo": "<string>",
"parsedPhoneNumber": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Personal access token from Pingmee Settings → Developer Tools
Business API key from Pingmee Settings → Developer Tools
Body
application/json
Array of customers to create.
Minimum array length:
1Customer full name
Phone number identifier including country code. (9725xxxxxxxx)
Profile image URL if available, if not provided we try and find a matching profile picture for that phone number.
Custom name to identify the customer in the business (not seen by the end user)
Free-text note / description controlled by the business (shown in the conversation sidebar)
Customer email address
Response
Customers created
Show child attributes
Show child attributes
Last modified on August 18, 2026
Was this page helpful?