cURL
curl -X PUT https://tawked.com/v1/chat/attendant/state \
-H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"enabled": true
}'const res = await fetch("https://tawked.com/v1/chat/attendant/state", {
method: "PUT",
headers: {
Authorization: "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx",
"Content-Type": "application/json",
},
body: JSON.stringify({
"enabled": true
}),
});
const data = await res.json();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tawked.com/v1/chat/attendant/state",
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([
'enabled' => true
]),
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
res = requests.put(
"https://tawked.com/v1/chat/attendant/state",
headers={"Authorization": "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"},
json={
"enabled": True
},
)
data = res.json(){
"state": "live",
"lock": null,
"enabled": true,
"mode": "menu_only",
"language": "ar",
"draft": {
"version": 1,
"opening": "⚽ أهلًا وسهلًا بك في أكاديمية النجوم لكرة القدم 💙\n\nيسعدنا تواصلك معنا، ونتطلع لمساعدة بطلنا في بدء رحلته الكروية 🌟\n\n👇 اختر من القائمة التالية الخدمة التي تحتاجها.",
"list_button": "القائمة",
"away": null,
"fallback": "💙 يمكنك اختيار الخدمة من القائمة، أو كتابة استفسارك مباشرة ليتم تحويل محادثتك إلى إدارة الأكاديمية.",
"choices": [
{
"id": "c_prices",
"title": "💰 أسعار الاشتراكات",
"description": null,
"action": {
"type": "reply",
"text": "💰 أسعار الاشتراكات في أكاديمية النجوم:\n\n🔹 شهر: 230 ريال\n🔹 3 أشهر: 630 ريال\n🔹 6 أشهر: 1,140 ريال\n🔹 سنة كاملة: 1,920 ريال\n\n📲 للتسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_programs",
"title": "⚽ البرامج والمواعيد",
"description": null,
"action": {
"type": "reply",
"text": "⚽ البرامج والمواعيد في أكاديمية النجوم:\n\n👦 الفئات العمرية: من 5 إلى 18 سنة، في مجموعات حسب العمر.\n📅 أيام التدريب: الأحد والثلاثاء والخميس.\n⏰ وقت التدريب: من بعد صلاة العصر حتى صلاة العشاء.\n\n📍 موقع الأكاديمية:",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_register",
"title": "📝 تسجيل لاعب جديد",
"description": null,
"action": {
"type": "reply",
"text": "📝 يسعدنا انضمام بطلنا إلى أكاديمية النجوم 🌟\n\nسجّل اللاعب من الرابط، واختر الفئة العمرية ومدة الاشتراك، وسيتواصل معك فريق الأكاديمية لتأكيد التسجيل.\n\n📲 رابط التسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_location",
"title": "📍 موقع الأكاديمية",
"description": null,
"action": {
"type": "reply",
"text": "📍 موقع أكاديمية النجوم 💙\n\nيسعدنا زيارتكم في أي وقت خلال أوقات التدريب.\n\nللوصول إلى الأكاديمية عبر خرائط Google 👇",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_team",
"title": "💬 التواصل مع الإدارة",
"description": null,
"action": {
"type": "team",
"line": "💬 تم تحويل محادثتك إلى إدارة أكاديمية النجوم ✅\n\nيرجى كتابة استفسارك، وسيقوم أحد أعضاء فريق الإدارة بالرد عليك في أقرب وقت ممكن.\n\n💙 نسعد بخدمتك دائمًا.",
"tag": "التواصل_مع_الإدارة",
"assign": {
"mode": "auto",
"member_id": null
}
}
}
]
},
"draft_saved_at": "2026-10-15T09:00:00Z",
"problems": [],
"published": {
"version": 1,
"published_at": "2026-10-15T09:01:00Z",
"menu": {
"version": 1,
"opening": "⚽ أهلًا وسهلًا بك في أكاديمية النجوم لكرة القدم 💙\n\nيسعدنا تواصلك معنا، ونتطلع لمساعدة بطلنا في بدء رحلته الكروية 🌟\n\n👇 اختر من القائمة التالية الخدمة التي تحتاجها.",
"list_button": "القائمة",
"away": null,
"fallback": "💙 يمكنك اختيار الخدمة من القائمة، أو كتابة استفسارك مباشرة ليتم تحويل محادثتك إلى إدارة الأكاديمية.",
"choices": [
{
"id": "c_prices",
"title": "💰 أسعار الاشتراكات",
"description": null,
"action": {
"type": "reply",
"text": "💰 أسعار الاشتراكات في أكاديمية النجوم:\n\n🔹 شهر: 230 ريال\n🔹 3 أشهر: 630 ريال\n🔹 6 أشهر: 1,140 ريال\n🔹 سنة كاملة: 1,920 ريال\n\n📲 للتسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_programs",
"title": "⚽ البرامج والمواعيد",
"description": null,
"action": {
"type": "reply",
"text": "⚽ البرامج والمواعيد في أكاديمية النجوم:\n\n👦 الفئات العمرية: من 5 إلى 18 سنة، في مجموعات حسب العمر.\n📅 أيام التدريب: الأحد والثلاثاء والخميس.\n⏰ وقت التدريب: من بعد صلاة العصر حتى صلاة العشاء.\n\n📍 موقع الأكاديمية:",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_register",
"title": "📝 تسجيل لاعب جديد",
"description": null,
"action": {
"type": "reply",
"text": "📝 يسعدنا انضمام بطلنا إلى أكاديمية النجوم 🌟\n\nسجّل اللاعب من الرابط، واختر الفئة العمرية ومدة الاشتراك، وسيتواصل معك فريق الأكاديمية لتأكيد التسجيل.\n\n📲 رابط التسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_location",
"title": "📍 موقع الأكاديمية",
"description": null,
"action": {
"type": "reply",
"text": "📍 موقع أكاديمية النجوم 💙\n\nيسعدنا زيارتكم في أي وقت خلال أوقات التدريب.\n\nللوصول إلى الأكاديمية عبر خرائط Google 👇",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_team",
"title": "💬 التواصل مع الإدارة",
"description": null,
"action": {
"type": "team",
"line": "💬 تم تحويل محادثتك إلى إدارة أكاديمية النجوم ✅\n\nيرجى كتابة استفسارك، وسيقوم أحد أعضاء فريق الإدارة بالرد عليك في أقرب وقت ممكن.\n\n💙 نسعد بخدمتك دائمًا.",
"tag": "التواصل_مع_الإدارة",
"assign": {
"mode": "auto",
"member_id": null
}
}
}
]
}
},
"changed": false
}
Chat
Switch the auto-attendant on or off
For a connected app’s key alone, with chat:attendant in its connection’s grant: an application’s own key, full access included, answers 403 insufficient_scope, and builds its auto-attendant in the console. Switches the auto-attendant on or off and answers the attendant object. On needs a published menu (409 attendant_unpublished), the number in Tawked Chat (409 chat_not_ready with reason number) and a number that can send (409 sending_blocked with reason payment or blocked). Off hands the conversations it holds to the team. Recorded in the client’s account record under the app’s name.
PUT
/
v1
/
chat
/
attendant
/
state
cURL
curl -X PUT https://tawked.com/v1/chat/attendant/state \
-H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"enabled": true
}'const res = await fetch("https://tawked.com/v1/chat/attendant/state", {
method: "PUT",
headers: {
Authorization: "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx",
"Content-Type": "application/json",
},
body: JSON.stringify({
"enabled": true
}),
});
const data = await res.json();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tawked.com/v1/chat/attendant/state",
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([
'enabled' => true
]),
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
res = requests.put(
"https://tawked.com/v1/chat/attendant/state",
headers={"Authorization": "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"},
json={
"enabled": True
},
)
data = res.json(){
"state": "live",
"lock": null,
"enabled": true,
"mode": "menu_only",
"language": "ar",
"draft": {
"version": 1,
"opening": "⚽ أهلًا وسهلًا بك في أكاديمية النجوم لكرة القدم 💙\n\nيسعدنا تواصلك معنا، ونتطلع لمساعدة بطلنا في بدء رحلته الكروية 🌟\n\n👇 اختر من القائمة التالية الخدمة التي تحتاجها.",
"list_button": "القائمة",
"away": null,
"fallback": "💙 يمكنك اختيار الخدمة من القائمة، أو كتابة استفسارك مباشرة ليتم تحويل محادثتك إلى إدارة الأكاديمية.",
"choices": [
{
"id": "c_prices",
"title": "💰 أسعار الاشتراكات",
"description": null,
"action": {
"type": "reply",
"text": "💰 أسعار الاشتراكات في أكاديمية النجوم:\n\n🔹 شهر: 230 ريال\n🔹 3 أشهر: 630 ريال\n🔹 6 أشهر: 1,140 ريال\n🔹 سنة كاملة: 1,920 ريال\n\n📲 للتسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_programs",
"title": "⚽ البرامج والمواعيد",
"description": null,
"action": {
"type": "reply",
"text": "⚽ البرامج والمواعيد في أكاديمية النجوم:\n\n👦 الفئات العمرية: من 5 إلى 18 سنة، في مجموعات حسب العمر.\n📅 أيام التدريب: الأحد والثلاثاء والخميس.\n⏰ وقت التدريب: من بعد صلاة العصر حتى صلاة العشاء.\n\n📍 موقع الأكاديمية:",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_register",
"title": "📝 تسجيل لاعب جديد",
"description": null,
"action": {
"type": "reply",
"text": "📝 يسعدنا انضمام بطلنا إلى أكاديمية النجوم 🌟\n\nسجّل اللاعب من الرابط، واختر الفئة العمرية ومدة الاشتراك، وسيتواصل معك فريق الأكاديمية لتأكيد التسجيل.\n\n📲 رابط التسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_location",
"title": "📍 موقع الأكاديمية",
"description": null,
"action": {
"type": "reply",
"text": "📍 موقع أكاديمية النجوم 💙\n\nيسعدنا زيارتكم في أي وقت خلال أوقات التدريب.\n\nللوصول إلى الأكاديمية عبر خرائط Google 👇",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_team",
"title": "💬 التواصل مع الإدارة",
"description": null,
"action": {
"type": "team",
"line": "💬 تم تحويل محادثتك إلى إدارة أكاديمية النجوم ✅\n\nيرجى كتابة استفسارك، وسيقوم أحد أعضاء فريق الإدارة بالرد عليك في أقرب وقت ممكن.\n\n💙 نسعد بخدمتك دائمًا.",
"tag": "التواصل_مع_الإدارة",
"assign": {
"mode": "auto",
"member_id": null
}
}
}
]
},
"draft_saved_at": "2026-10-15T09:00:00Z",
"problems": [],
"published": {
"version": 1,
"published_at": "2026-10-15T09:01:00Z",
"menu": {
"version": 1,
"opening": "⚽ أهلًا وسهلًا بك في أكاديمية النجوم لكرة القدم 💙\n\nيسعدنا تواصلك معنا، ونتطلع لمساعدة بطلنا في بدء رحلته الكروية 🌟\n\n👇 اختر من القائمة التالية الخدمة التي تحتاجها.",
"list_button": "القائمة",
"away": null,
"fallback": "💙 يمكنك اختيار الخدمة من القائمة، أو كتابة استفسارك مباشرة ليتم تحويل محادثتك إلى إدارة الأكاديمية.",
"choices": [
{
"id": "c_prices",
"title": "💰 أسعار الاشتراكات",
"description": null,
"action": {
"type": "reply",
"text": "💰 أسعار الاشتراكات في أكاديمية النجوم:\n\n🔹 شهر: 230 ريال\n🔹 3 أشهر: 630 ريال\n🔹 6 أشهر: 1,140 ريال\n🔹 سنة كاملة: 1,920 ريال\n\n📲 للتسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_programs",
"title": "⚽ البرامج والمواعيد",
"description": null,
"action": {
"type": "reply",
"text": "⚽ البرامج والمواعيد في أكاديمية النجوم:\n\n👦 الفئات العمرية: من 5 إلى 18 سنة، في مجموعات حسب العمر.\n📅 أيام التدريب: الأحد والثلاثاء والخميس.\n⏰ وقت التدريب: من بعد صلاة العصر حتى صلاة العشاء.\n\n📍 موقع الأكاديمية:",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_register",
"title": "📝 تسجيل لاعب جديد",
"description": null,
"action": {
"type": "reply",
"text": "📝 يسعدنا انضمام بطلنا إلى أكاديمية النجوم 🌟\n\nسجّل اللاعب من الرابط، واختر الفئة العمرية ومدة الاشتراك، وسيتواصل معك فريق الأكاديمية لتأكيد التسجيل.\n\n📲 رابط التسجيل الإلكتروني:",
"link": "https://app.yourplatform.example/register?academy=ACADEMY_ID"
}
},
{
"id": "c_location",
"title": "📍 موقع الأكاديمية",
"description": null,
"action": {
"type": "reply",
"text": "📍 موقع أكاديمية النجوم 💙\n\nيسعدنا زيارتكم في أي وقت خلال أوقات التدريب.\n\nللوصول إلى الأكاديمية عبر خرائط Google 👇",
"link": "https://maps.app.goo.gl/EXAMPLE"
}
},
{
"id": "c_team",
"title": "💬 التواصل مع الإدارة",
"description": null,
"action": {
"type": "team",
"line": "💬 تم تحويل محادثتك إلى إدارة أكاديمية النجوم ✅\n\nيرجى كتابة استفسارك، وسيقوم أحد أعضاء فريق الإدارة بالرد عليك في أقرب وقت ممكن.\n\n💙 نسعد بخدمتك دائمًا.",
"tag": "التواصل_مع_الإدارة",
"assign": {
"mode": "auto",
"member_id": null
}
}
}
]
}
},
"changed": false
}
Guide: Connected apps
Authorizations
bearerKeyheaderKey
Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.
Headers
A 1 to 128 printable-ASCII-character key you generate, scoped to your API key. Replaying it with the same request answers the original 2xx unchanged, with the response header Idempotent-Replayed: true, and runs nothing again; the same key with another request answers 409 idempotency_key_reused, and a request still in flight 409 idempotency_in_progress. A refused request is never stored, so a corrected retry under the same key runs. Keys expire after 24 hours.
Body
application/json
true switches it on, false off. Refused: required (missing or not a boolean).