Contacts
Create contact
Create a new WhatsApp contact.
POST
/
whatsapp
/
contacts
Create contact
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contact": {
"wa_id": "+15551234567",
"profile_name": "<string>",
"display_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
}
'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/contacts"
payload = { "contact": {
"wa_id": "+15551234567",
"profile_name": "<string>",
"display_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
wa_id: '+15551234567',
profile_name: '<string>',
display_name: '<string>',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
}
})
};
fetch('https://api.kapso.ai/platform/v1/whatsapp/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://api.kapso.ai/platform/v1/whatsapp/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([
'contact' => [
'wa_id' => '+15551234567',
'profile_name' => '<string>',
'display_name' => '<string>',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.kapso.ai/platform/v1/whatsapp/contacts"
payload := strings.NewReader("{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.kapso.ai/platform/v1/whatsapp/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"wa_id": "15551234567",
"business_scoped_user_id": "US.13491208655302741918",
"parent_business_scoped_user_id": "US.ENT.506847293015824",
"username": "@testusername",
"profile_name": "John Doe",
"display_name": "John (VIP)",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}Was this page helpful?
⌘I
Create contact
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contact": {
"wa_id": "+15551234567",
"profile_name": "<string>",
"display_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
}
'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/contacts"
payload = { "contact": {
"wa_id": "+15551234567",
"profile_name": "<string>",
"display_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
wa_id: '+15551234567',
profile_name: '<string>',
display_name: '<string>',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
}
})
};
fetch('https://api.kapso.ai/platform/v1/whatsapp/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://api.kapso.ai/platform/v1/whatsapp/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([
'contact' => [
'wa_id' => '+15551234567',
'profile_name' => '<string>',
'display_name' => '<string>',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.kapso.ai/platform/v1/whatsapp/contacts"
payload := strings.NewReader("{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.kapso.ai/platform/v1/whatsapp/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"wa_id\": \"+15551234567\",\n \"profile_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"wa_id": "15551234567",
"business_scoped_user_id": "US.13491208655302741918",
"parent_business_scoped_user_id": "US.ENT.506847293015824",
"username": "@testusername",
"profile_name": "John Doe",
"display_name": "John (VIP)",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}
