Console

Update conversation

.md

PATCH

https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/conversations/{id}

Token ability: conversations.manage · Authentication

Work the conversation: change its status (snoozing needs snoozed_until), priority or tags (replaced), assign it to an inbox member (assignee: the staff member's external_id, or null to unassign), and send read: true when your staff have seen its messages. Changes are announced as conversation.updated.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

id integer required

PaalChat's conversation ID.

Body parameters

status string

open = needs the business; pending = waiting for the customer (a conversation the business started); an incoming message reopens pending, resolved and snoozed conversations; after closed, the next message starts a new conversation.

One of: open, pending, resolved, closed, snoozed.

snoozed_until string | null

Format date-time.

priority string

One of: low, normal, high, urgent.

tags array of strings

read boolean

Always 1.

assignee string | null

An active inbox member's external_id (sign them in first), or null.

Responses

200

The updated conversation.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

422

validation_failed, or unknown_member (no active inbox member with that assignee).

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.

Language

Credentials

Authorization Bearer $PAALCHAT_TOKEN

Request

cURL

curl --request PATCH \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"status": "resolved", "tags": ["fees"], "read": true}'

const response = await fetch('https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.PAALCHAT_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"status": "resolved", "tags": ["fees"], "read": true}),
});

const data = await response.json();
console.log(response.status, data);

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('PAALCHAT_TOKEN'))
    ->acceptJson()
    ->patch('https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2', ['status' => 'resolved', 'tags' => ['fees'], 'read' => true]);

$data = $response->json();

import os
import requests

response = requests.patch(
    "https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2",
    headers={"Authorization": f"Bearer {os.environ['PAALCHAT_TOKEN']}", "Accept": "application/json"},
    json={"status": "resolved", "tags": ["fees"], "read": True},
)

print(response.status_code, response.json())

require 'net/http'
require 'json'

uri = URI('https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = "Bearer #{ENV['PAALCHAT_TOKEN']}"
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
  {"status": "resolved", "tags": ["fees"], "read": true}
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, JSON.parse(response.body)

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("PATCH", "https://whatsapp.paaltech.org/api/v1/businesses/presec/conversations/2", strings.NewReader(`{"status": "resolved", "tags": ["fees"], "read": true}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAALCHAT_TOKEN"))
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

Try it with a test key

Only sk_test_ keys: requests reach your sandbox businesses, never real ones. The key is not saved.

Test key

external_id

id

JSON body

Response

Response

{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}

{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}

{"error": {"code": "not_found", "message": "Business not found."}}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}