radeef.settings.update

Save one section of Radeef's settings (`persona`, `pace`, `handoff`, `hours`, `limits` or `store`), the whole section as radeef.settings.show answers it; answers the settings.

curl --request PUT \
  --url https://tawked.com/v1/applications/{application}/radeef/settings/{section} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "csat": true,
  "etiquette": true,
  "idle_minutes": 125,
  "orders": true,
  "persona_name": "<string>",
  "products": true,
  "read_receipts": true,
  "reply_cap": 22,
  "split": true,
  "strict": true,
  "topics": {
    "refunds": true,
    "complaints": true
  },
  "typing": true,
  "assign_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_enabled": true,
  "custom_topics": [
    "<string>"
  ],
  "keywords": [
    "<string>"
  ],
  "keywords_enabled": true,
  "messages": {
    "saudi": {
      "inside": "<string>",
      "outside": "<string>"
    },
    "msa": {
      "inside": "<string>",
      "outside": "<string>"
    },
    "en": {
      "inside": "<string>",
      "outside": "<string>"
    }
  },
  "monthly_cap_halalas": 5000050,
  "order_status": true,
  "persona_name_en": "<string>",
  "ramadan": {
    "sun": [
      "<string>"
    ],
    "mon": [
      "<string>"
    ],
    "tue": [
      "<string>"
    ],
    "wed": [
      "<string>"
    ],
    "thu": [
      "<string>"
    ],
    "fri": [
      "<string>"
    ],
    "sat": [
      "<string>"
    ]
  },
  "week": {
    "sun": {
      "from": "<string>",
      "to": "<string>"
    },
    "mon": {
      "from": "<string>",
      "to": "<string>"
    },
    "tue": {
      "from": "<string>",
      "to": "<string>"
    },
    "wed": {
      "from": "<string>",
      "to": "<string>"
    },
    "thu": {
      "from": "<string>",
      "to": "<string>"
    },
    "fri": {
      "from": "<string>",
      "to": "<string>"
    },
    "sat": {
      "from": "<string>",
      "to": "<string>"
    }
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    csat: true,
    etiquette: true,
    idle_minutes: 125,
    orders: true,
    persona_name: '<string>',
    products: true,
    read_receipts: true,
    reply_cap: 22,
    split: true,
    strict: true,
    topics: {refunds: true, complaints: true},
    typing: true,
    assign_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_enabled: true,
    custom_topics: ['<string>'],
    keywords: ['<string>'],
    keywords_enabled: true,
    messages: {
      saudi: {inside: '<string>', outside: '<string>'},
      msa: {inside: '<string>', outside: '<string>'},
      en: {inside: '<string>', outside: '<string>'}
    },
    monthly_cap_halalas: 5000050,
    order_status: true,
    persona_name_en: '<string>',
    ramadan: {
      sun: ['<string>'],
      mon: ['<string>'],
      tue: ['<string>'],
      wed: ['<string>'],
      thu: ['<string>'],
      fri: ['<string>'],
      sat: ['<string>']
    },
    week: {
      sun: {from: '<string>', to: '<string>'},
      mon: {from: '<string>', to: '<string>'},
      tue: {from: '<string>', to: '<string>'},
      wed: {from: '<string>', to: '<string>'},
      thu: {from: '<string>', to: '<string>'},
      fri: {from: '<string>', to: '<string>'},
      sat: {from: '<string>', to: '<string>'}
    }
  })
};

fetch('https://tawked.com/v1/applications/{application}/radeef/settings/{section}', 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}/radeef/settings/{section}",
  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([
    'csat' => true,
    'etiquette' => true,
    'idle_minutes' => 125,
    'orders' => true,
    'persona_name' => '<string>',
    'products' => true,
    'read_receipts' => true,
    'reply_cap' => 22,
    'split' => true,
    'strict' => true,
    'topics' => [
        'refunds' => true,
        'complaints' => true
    ],
    'typing' => true,
    'assign_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_enabled' => true,
    'custom_topics' => [
        '<string>'
    ],
    'keywords' => [
        '<string>'
    ],
    'keywords_enabled' => true,
    'messages' => [
        'saudi' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ],
        'msa' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ],
        'en' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ]
    ],
    'monthly_cap_halalas' => 5000050,
    'order_status' => true,
    'persona_name_en' => '<string>',
    'ramadan' => [
        'sun' => [
                '<string>'
        ],
        'mon' => [
                '<string>'
        ],
        'tue' => [
                '<string>'
        ],
        'wed' => [
                '<string>'
        ],
        'thu' => [
                '<string>'
        ],
        'fri' => [
                '<string>'
        ],
        'sat' => [
                '<string>'
        ]
    ],
    'week' => [
        'sun' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'mon' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'tue' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'wed' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'thu' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'fri' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'sat' => [
                'from' => '<string>',
                'to' => '<string>'
        ]
    ]
  ]),
  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}/radeef/settings/{section}"

payload = {
    "csat": True,
    "etiquette": True,
    "idle_minutes": 125,
    "orders": True,
    "persona_name": "<string>",
    "products": True,
    "read_receipts": True,
    "reply_cap": 22,
    "split": True,
    "strict": True,
    "topics": {
        "refunds": True,
        "complaints": True
    },
    "typing": True,
    "assign_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_enabled": True,
    "custom_topics": ["<string>"],
    "keywords": ["<string>"],
    "keywords_enabled": True,
    "messages": {
        "saudi": {
            "inside": "<string>",
            "outside": "<string>"
        },
        "msa": {
            "inside": "<string>",
            "outside": "<string>"
        },
        "en": {
            "inside": "<string>",
            "outside": "<string>"
        }
    },
    "monthly_cap_halalas": 5000050,
    "order_status": True,
    "persona_name_en": "<string>",
    "ramadan": {
        "sun": ["<string>"],
        "mon": ["<string>"],
        "tue": ["<string>"],
        "wed": ["<string>"],
        "thu": ["<string>"],
        "fri": ["<string>"],
        "sat": ["<string>"]
    },
    "week": {
        "sun": {
            "from": "<string>",
            "to": "<string>"
        },
        "mon": {
            "from": "<string>",
            "to": "<string>"
        },
        "tue": {
            "from": "<string>",
            "to": "<string>"
        },
        "wed": {
            "from": "<string>",
            "to": "<string>"
        },
        "thu": {
            "from": "<string>",
            "to": "<string>"
        },
        "fri": {
            "from": "<string>",
            "to": "<string>"
        },
        "sat": {
            "from": "<string>",
            "to": "<string>"
        }
    }
}
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}

radeef

settings

{section}

Save one section of Radeef's settings (`persona`, `pace`, `handoff`, `hours`, `limits` or `store`), the whole section as radeef.settings.show answers it; answers the settings.

curl --request PUT \
  --url https://tawked.com/v1/applications/{application}/radeef/settings/{section} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "csat": true,
  "etiquette": true,
  "idle_minutes": 125,
  "orders": true,
  "persona_name": "<string>",
  "products": true,
  "read_receipts": true,
  "reply_cap": 22,
  "split": true,
  "strict": true,
  "topics": {
    "refunds": true,
    "complaints": true
  },
  "typing": true,
  "assign_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_enabled": true,
  "custom_topics": [
    "<string>"
  ],
  "keywords": [
    "<string>"
  ],
  "keywords_enabled": true,
  "messages": {
    "saudi": {
      "inside": "<string>",
      "outside": "<string>"
    },
    "msa": {
      "inside": "<string>",
      "outside": "<string>"
    },
    "en": {
      "inside": "<string>",
      "outside": "<string>"
    }
  },
  "monthly_cap_halalas": 5000050,
  "order_status": true,
  "persona_name_en": "<string>",
  "ramadan": {
    "sun": [
      "<string>"
    ],
    "mon": [
      "<string>"
    ],
    "tue": [
      "<string>"
    ],
    "wed": [
      "<string>"
    ],
    "thu": [
      "<string>"
    ],
    "fri": [
      "<string>"
    ],
    "sat": [
      "<string>"
    ]
  },
  "week": {
    "sun": {
      "from": "<string>",
      "to": "<string>"
    },
    "mon": {
      "from": "<string>",
      "to": "<string>"
    },
    "tue": {
      "from": "<string>",
      "to": "<string>"
    },
    "wed": {
      "from": "<string>",
      "to": "<string>"
    },
    "thu": {
      "from": "<string>",
      "to": "<string>"
    },
    "fri": {
      "from": "<string>",
      "to": "<string>"
    },
    "sat": {
      "from": "<string>",
      "to": "<string>"
    }
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    csat: true,
    etiquette: true,
    idle_minutes: 125,
    orders: true,
    persona_name: '<string>',
    products: true,
    read_receipts: true,
    reply_cap: 22,
    split: true,
    strict: true,
    topics: {refunds: true, complaints: true},
    typing: true,
    assign_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_enabled: true,
    custom_topics: ['<string>'],
    keywords: ['<string>'],
    keywords_enabled: true,
    messages: {
      saudi: {inside: '<string>', outside: '<string>'},
      msa: {inside: '<string>', outside: '<string>'},
      en: {inside: '<string>', outside: '<string>'}
    },
    monthly_cap_halalas: 5000050,
    order_status: true,
    persona_name_en: '<string>',
    ramadan: {
      sun: ['<string>'],
      mon: ['<string>'],
      tue: ['<string>'],
      wed: ['<string>'],
      thu: ['<string>'],
      fri: ['<string>'],
      sat: ['<string>']
    },
    week: {
      sun: {from: '<string>', to: '<string>'},
      mon: {from: '<string>', to: '<string>'},
      tue: {from: '<string>', to: '<string>'},
      wed: {from: '<string>', to: '<string>'},
      thu: {from: '<string>', to: '<string>'},
      fri: {from: '<string>', to: '<string>'},
      sat: {from: '<string>', to: '<string>'}
    }
  })
};

fetch('https://tawked.com/v1/applications/{application}/radeef/settings/{section}', 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}/radeef/settings/{section}",
  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([
    'csat' => true,
    'etiquette' => true,
    'idle_minutes' => 125,
    'orders' => true,
    'persona_name' => '<string>',
    'products' => true,
    'read_receipts' => true,
    'reply_cap' => 22,
    'split' => true,
    'strict' => true,
    'topics' => [
        'refunds' => true,
        'complaints' => true
    ],
    'typing' => true,
    'assign_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_enabled' => true,
    'custom_topics' => [
        '<string>'
    ],
    'keywords' => [
        '<string>'
    ],
    'keywords_enabled' => true,
    'messages' => [
        'saudi' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ],
        'msa' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ],
        'en' => [
                'inside' => '<string>',
                'outside' => '<string>'
        ]
    ],
    'monthly_cap_halalas' => 5000050,
    'order_status' => true,
    'persona_name_en' => '<string>',
    'ramadan' => [
        'sun' => [
                '<string>'
        ],
        'mon' => [
                '<string>'
        ],
        'tue' => [
                '<string>'
        ],
        'wed' => [
                '<string>'
        ],
        'thu' => [
                '<string>'
        ],
        'fri' => [
                '<string>'
        ],
        'sat' => [
                '<string>'
        ]
    ],
    'week' => [
        'sun' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'mon' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'tue' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'wed' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'thu' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'fri' => [
                'from' => '<string>',
                'to' => '<string>'
        ],
        'sat' => [
                'from' => '<string>',
                'to' => '<string>'
        ]
    ]
  ]),
  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}/radeef/settings/{section}"

payload = {
    "csat": True,
    "etiquette": True,
    "idle_minutes": 125,
    "orders": True,
    "persona_name": "<string>",
    "products": True,
    "read_receipts": True,
    "reply_cap": 22,
    "split": True,
    "strict": True,
    "topics": {
        "refunds": True,
        "complaints": True
    },
    "typing": True,
    "assign_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_enabled": True,
    "custom_topics": ["<string>"],
    "keywords": ["<string>"],
    "keywords_enabled": True,
    "messages": {
        "saudi": {
            "inside": "<string>",
            "outside": "<string>"
        },
        "msa": {
            "inside": "<string>",
            "outside": "<string>"
        },
        "en": {
            "inside": "<string>",
            "outside": "<string>"
        }
    },
    "monthly_cap_halalas": 5000050,
    "order_status": True,
    "persona_name_en": "<string>",
    "ramadan": {
        "sun": ["<string>"],
        "mon": ["<string>"],
        "tue": ["<string>"],
        "wed": ["<string>"],
        "thu": ["<string>"],
        "fri": ["<string>"],
        "sat": ["<string>"]
    },
    "week": {
        "sun": {
            "from": "<string>",
            "to": "<string>"
        },
        "mon": {
            "from": "<string>",
            "to": "<string>"
        },
        "tue": {
            "from": "<string>",
            "to": "<string>"
        },
        "wed": {
            "from": "<string>",
            "to": "<string>"
        },
        "thu": {
            "from": "<string>",
            "to": "<string>"
        },
        "fri": {
            "from": "<string>",
            "to": "<string>"
        },
        "sat": {
            "from": "<string>",
            "to": "<string>"
        }
    }
}
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})$

section

string

required

One section of Radeef's settings: persona, pace, handoff, hours, limits or store; list them with radeef.settings.show.

Body

application/json

assign_mode

enum<string>

required

Available options:

auto,

member,

none

csat

boolean

required

emoji

enum<string>

required

Available options:

none,

few

etiquette

boolean

required

idle_minutes

integer

required

Required range: 10 <= x <= 240

intro

enum<string>

required

Available options:

warm,

brief

mode

enum<string>

required

Available options:

always,

outside,

inside

orders

boolean

required

persona_name

string

required

Maximum string length: 40

Pattern: ^[\p{L}\p{M} ـ]+$/u

products

boolean

required

read_receipts

boolean

required

enum<string>

required

Available options:

saudi,

msa,

mirror

reply_cap

integer

required

Required range: 5 <= x <= 40

reply_length

enum<string>

required

Available options:

short,

standard

speed

enum<string>

required

Available options:

fast,

natural,

relaxed

split

boolean

required

strict

boolean

required

topics

object

required

Show child attributes

typing

boolean

required

assign_member_id

string<uuid> | null

Required when assign_mode is member.

custom_enabled

boolean

custom_topics

string[]

Maximum array length: 10

Maximum string length: 120

Pattern: \S

keywords

string[]

Maximum array length: 30

Maximum string length: 40

Pattern: \S

keywords_enabled

boolean

messages

object

Show child attributes

monthly_cap_halalas

integer | null

Required range: 100 <= x <= 10000000

order_status

boolean

persona_name_en

string | null

Maximum string length: 40

Pattern: ^[A-Za-z][A-Za-z '\-]*$

ramadan

object | null

Show child attributes

return_after_hours

enum<integer> | null

Available options:

12,

24,

48

week

object

Show child attributes

Response

Done.

data

object

required