Skip to main content
POST
Add a chat menu: a page of your business (`title`, an https `url`) shown beside this application's conversations in Tawked Chat; `icon_mode` takes the site's icon (`site`, the default), an uploaded `icon` (`upload`) or none. Answers the menu.

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

multipart/form-data
title
string
required
Required string length: 2 - 30
url
string
required
Maximum string length: 1024
icon
file | null
icon_mode
enum<string>
Available options:
site,
upload,
none

Response

Created.

data
object
required