Skip to main content
PATCH
Change a member's name, e-mail, role and what they manage (the phone never changes: it is how they sign in); answers the member.

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
Tawked-Approval
string<uuid>

The id of an approval its person approved (approvals.show answers approved): the same request then runs, once.

Path Parameters

member
string
required

A person's id (a UUID); list them with members.members.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
name
string
required
Required string length: 2 - 80
role
enum<string>
required
Available options:
admin,
developer,
viewer
access
object[]
all_applications
boolean
clients_access
enum<string>
Available options:
none,
read,
manage
email
string<email> | null
Maximum string length: 191

Response

Done.

data
object
required