chat.attendant.update_settings

Change the auto-attendant's settings: `mode` (`menu_then_radeef` or `menu_only`), the customers' `language` (`ar` or `en`), and who gets a fallback handoff (`fallback_assign`: `auto` or `member` with `fallback_member_id`, one of `assignees`). Answers the attendant and the settings before.

curl --request PUT \
  --url https://tawked.com/v1/applications/{application}/chat/attendant/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fallback_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fallback_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://tawked.com/v1/applications/{application}/chat/attendant/settings', 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://tawked.com/v1/applications/{application}/chat/attendant/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'fallback_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/applications/{application}/chat/attendant/settings"

payload = { "fallback_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

PUT

applications

{application}

chat

attendant

settings

curl --request PUT \
  --url https://tawked.com/v1/applications/{application}/chat/attendant/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fallback_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fallback_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://tawked.com/v1/applications/{application}/chat/attendant/settings', 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://tawked.com/v1/applications/{application}/chat/attendant/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'fallback_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/applications/{application}/chat/attendant/settings"

payload = { "fallback_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key

string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Path Parameters

application

string

required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json

fallback_assign

enum<string>

Available options:

auto,

member

fallback_member_id

string<uuid> | null

Required when fallback_assign is member.

language

enum<string>

Available options:

ar,

en

mode

enum<string>

Available options:

menu_then_radeef,

menu_only

Response

Done.

data

object

required