Skip to main content
PUT
Change the business profile customers see on WhatsApp (about, address, description, e-mail, up to two websites, category, a JPG or PNG picture); a field left out stays as it is. Answers the number.

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
about
string
required
Maximum string length: 139
address
string | null
Maximum string length: 256
description
string | null
Maximum string length: 512
email
string<email> | null
Maximum string length: 128
picture
file | null
Maximum string length: 5120
vertical
enum<string> | null
Available options:
ALCOHOL,
APPAREL,
AUTO,
BEAUTY,
EDU,
ENTERTAIN,
EVENT_PLAN,
FINANCE,
GOVT,
GROCERY,
HEALTH,
HOTEL,
NONPROFIT,
ONLINE_GAMBLING,
OTC_DRUGS,
OTHER,
PHYSICAL_GAMBLING,
PROF_SERVICES,
RESTAURANT,
RETAIL,
TRAVEL,
UNDEFINED
websites
(string<uri> | null)[] | null
Maximum array length: 2
Maximum string length: 256

Response

Done.

data
object
required