Skip to main content
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>",
  "email": "[email protected]"
}
'
{
  "profileImage": "<string>",
  "customerName": "<string>",
  "customerNickname": "<string>",
  "createdAt": 123,
  "lastActiveAt": 123,
  "email": "[email protected]",
  "platform": "whatsapp",
  "phoneNumberId": "<string>",
  "countryCode": "<string>",
  "associatedTo": "<string>",
  "parsedPhoneNumber": "<string>"
}

Authorizations

​
Cookie
string
header
required
​
x-api-key
string
header
required

Body

application/json

A list of customers to create

​
customerName
string
required

Customer full name

​
phoneNumberId
string
required

Phone number identifier including country code. (9725xxxxxxxx)

​
profileImage
string | null

Profile image URL if available, if not provided we try and find a matching profile picture for that phone number.

​
customerNickname
string

Custom name to identify the customer in the business (not seen by the end user)

​
email
string<email>

Customer email address

Response

Customers created

​
profileImage
string | null

Profile image URL if available

​
customerName
string

The name from WhatsApp or the originating platform

​
customerNickname
string

The name the business gave the customer

​
createdAt
number

Unix timestamp (milliseconds) when the customer was created

​
lastActiveAt
number

Unix timestamp (milliseconds) when the customer was last active

​
email
string<email>

Customer email address

​
platform
enum<string>

Messaging platform the customer is associated with

Available options:
whatsapp,
instagram,
facebookMessenger
​
phoneNumberId
string

Platform-specific phone number identifier

​
countryCode
string

Country calling code

​
associatedTo
string

Business or account the customer is associated with

​
parsedPhoneNumber
string

Normalized phone number if available