Create a WhatsApp contact

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contact": {
    "wa_id": "1234567890",
    "profile_name": "John Doe",
    "customer_id": "customer-456def",
    "metadata": {
      "source": "website",
      "tags": [
        "lead",
        "priority"
      ]
    }
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_contacts"

payload = { "contact": {
        "wa_id": "1234567890",
        "profile_name": "John Doe",
        "customer_id": "customer-456def",
        "metadata": {
            "source": "website",
            "tags": ["lead", "priority"]
        }
    } }
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: '1234567890',
      profile_name: 'John Doe',
      customer_id: 'customer-456def',
      metadata: {source: 'website', tags: ['lead', 'priority']}
    }
  })
};

fetch('https://app.kapso.ai/api/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://app.kapso.ai/api/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' => '1234567890',
        'profile_name' => 'John Doe',
        'customer_id' => 'customer-456def',
        'metadata' => [
                'source' => 'website',
                'tags' => [
                                'lead',
                                'priority'
                ]
        ]
    ]
  ]),
  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://app.kapso.ai/api/v1/whatsapp_contacts"

	payload := strings.NewReader("{\n  \"contact\": {\n    \"wa_id\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\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://app.kapso.ai/api/v1/whatsapp_contacts")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact\": {\n    \"wa_id\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/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\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "contact-789ghi",
    "wa_id": "1234567890",
    "profile_name": "John Doe",
    "customer_id": "customer-456def",
    "metadata": {
      "source": "website",
      "tags": [
        "lead",
        "priority"
      ]
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "errors": [
    "Wa_id has already been taken"
  ]
}

POST

whatsapp_contacts

Create a WhatsApp contact

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contact": {
    "wa_id": "1234567890",
    "profile_name": "John Doe",
    "customer_id": "customer-456def",
    "metadata": {
      "source": "website",
      "tags": [
        "lead",
        "priority"
      ]
    }
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_contacts"

payload = { "contact": {
        "wa_id": "1234567890",
        "profile_name": "John Doe",
        "customer_id": "customer-456def",
        "metadata": {
            "source": "website",
            "tags": ["lead", "priority"]
        }
    } }
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: '1234567890',
      profile_name: 'John Doe',
      customer_id: 'customer-456def',
      metadata: {source: 'website', tags: ['lead', 'priority']}
    }
  })
};

fetch('https://app.kapso.ai/api/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://app.kapso.ai/api/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' => '1234567890',
        'profile_name' => 'John Doe',
        'customer_id' => 'customer-456def',
        'metadata' => [
                'source' => 'website',
                'tags' => [
                                'lead',
                                'priority'
                ]
        ]
    ]
  ]),
  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://app.kapso.ai/api/v1/whatsapp_contacts"

	payload := strings.NewReader("{\n  \"contact\": {\n    \"wa_id\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\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://app.kapso.ai/api/v1/whatsapp_contacts")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact\": {\n    \"wa_id\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/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\": \"1234567890\",\n    \"profile_name\": \"John Doe\",\n    \"customer_id\": \"customer-456def\",\n    \"metadata\": {\n      \"source\": \"website\",\n      \"tags\": [\n        \"lead\",\n        \"priority\"\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "contact-789ghi",
    "wa_id": "1234567890",
    "profile_name": "John Doe",
    "customer_id": "customer-456def",
    "metadata": {
      "source": "website",
      "tags": [
        "lead",
        "priority"
      ]
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "errors": [
    "Wa_id has already been taken"
  ]
}

Authorizations

X-API-Key

string

header

required

API key required for all endpoints

Body

application/json

contact

object

required

Show child attributes

Response

Contact created successfully

data

object

Show child attributes

Guides

WhatsApp Conversations

WhatsApp Messages

Conversation Assignments

WhatsApp Templates

WhatsApp Contacts

WhatsApp Contact Notes

WhatsApp Configs

WhatsApp Calls

WhatsApp Contact Call Permissions

Create a WhatsApp contact

Authorizations

Body

Response