Update a WhatsApp contact

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contact": {
    "profile_name": "John Doe - VIP Customer",
    "metadata": {
      "vip": true,
      "subscription_tier": "premium"
    }
  }
}
'

import requests

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

payload = { "contact": {
        "profile_name": "John Doe - VIP Customer",
        "metadata": {
            "vip": True,
            "subscription_tier": "premium"
        }
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contact: {
      profile_name: 'John Doe - VIP Customer',
      metadata: {vip: true, subscription_tier: 'premium'}
    }
  })
};

fetch('https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}', 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/{identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'contact' => [
        'profile_name' => 'John Doe - VIP Customer',
        'metadata' => [
                'vip' => true,
                'subscription_tier' => 'premium'
        ]
    ]
  ]),
  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/{identifier}"

	payload := strings.NewReader("{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\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"
}

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

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

PATCH

whatsapp_contacts

{identifier}

Update a WhatsApp contact

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contact": {
    "profile_name": "John Doe - VIP Customer",
    "metadata": {
      "vip": true,
      "subscription_tier": "premium"
    }
  }
}
'

import requests

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

payload = { "contact": {
        "profile_name": "John Doe - VIP Customer",
        "metadata": {
            "vip": True,
            "subscription_tier": "premium"
        }
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contact: {
      profile_name: 'John Doe - VIP Customer',
      metadata: {vip: true, subscription_tier: 'premium'}
    }
  })
};

fetch('https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}', 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/{identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'contact' => [
        'profile_name' => 'John Doe - VIP Customer',
        'metadata' => [
                'vip' => true,
                'subscription_tier' => 'premium'
        ]
    ]
  ]),
  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/{identifier}"

	payload := strings.NewReader("{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_contacts/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact\": {\n    \"profile_name\": \"John Doe - VIP Customer\",\n    \"metadata\": {\n      \"vip\": true,\n      \"subscription_tier\": \"premium\"\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"
}

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

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

Authorizations

X-API-Key

string

header

required

API key required for all endpoints

Path Parameters

identifier

string

required

Contact ID (UUID) or phone number

Example:

"contact-789ghi or 1234567890"

Body

application/json

contact

object

Show child attributes

Response

Successful response

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

Update a WhatsApp contact

Authorizations

Path Parameters

Body

Response