Skip to main content
POST
Create a receiving address: `kind` hosted (a Tawked address, `slug` optional: `<slug>.inbound.tawked.com`, ready at once) or domain (`domain_id` a verified sending domain, `label` optional, default inbound: one MX record to add). Answers the address and `next`.

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

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

application/json
kind
enum<string>
required
Available options:
hosted,
domain
domain_id
string<uuid> | null
label
string | null
Maximum string length: 63
slug
string | null
Maximum string length: 63

Response

Created.

data
object
required