Update WhatsApp conversation status

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_conversation": {
    "status": "ended"
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}"

payload = { "whatsapp_conversation": { "status": "ended" } }
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({whatsapp_conversation: {status: 'ended'}})
};

fetch('https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}', 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_conversations/{conversation_id}",
  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([
    'whatsapp_conversation' => [
        'status' => 'ended'
    ]
  ]),
  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_conversations/{conversation_id}"

	payload := strings.NewReader("{\n  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\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_conversations/{conversation_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\n  }\n}"

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

{
  "data": {
    "id": "conversation-202mno",
    "phone_number": "+1234567890",
    "status": "active",
    "last_active_at": "2023-11-07T05:31:56Z",
    "contact_name": "John Doe",
    "whatsapp_config_id": "config-123abc"
  }
}

{
  "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_conversations

{conversation_id}

Update WhatsApp conversation status

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_conversation": {
    "status": "ended"
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}"

payload = { "whatsapp_conversation": { "status": "ended" } }
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({whatsapp_conversation: {status: 'ended'}})
};

fetch('https://app.kapso.ai/api/v1/whatsapp_conversations/{conversation_id}', 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_conversations/{conversation_id}",
  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([
    'whatsapp_conversation' => [
        'status' => 'ended'
    ]
  ]),
  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_conversations/{conversation_id}"

	payload := strings.NewReader("{\n  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\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_conversations/{conversation_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"whatsapp_conversation\": {\n    \"status\": \"ended\"\n  }\n}"

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

{
  "data": {
    "id": "conversation-202mno",
    "phone_number": "+1234567890",
    "status": "active",
    "last_active_at": "2023-11-07T05:31:56Z",
    "contact_name": "John Doe",
    "whatsapp_config_id": "config-123abc"
  }
}

{
  "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

conversation_id

string

required

Body

application/json

whatsapp_conversation

object

required

Show child attributes

Response

WhatsApp conversation updated 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

Update WhatsApp conversation status

Authorizations

Path Parameters

Body

Response