> ## Documentation Index > Fetch the complete documentation index at: https://docs.tawked.com/llms.txt > Use this file to discover all available pages before exploring further. # Add a domain > Adds a sending domain to the application and answers its records to put at your DNS host: the DKIM key's TXT record, and the return path's MX and TXT records. Tawked checks them every ten minutes, or at once with `POST /v1/email/domains/{id}/verify`. `201` with the new domain; `200` with the one the application already has. A live key of the application with the explicit `email:manage`: a full-access key does not hold it. At most ten a minute for an application. Guide: [Domains by API](https://docs.tawked.com/email/domains.md) ## OpenAPI ````yaml https://tawked.com/openapi.json post /v1/email/domains openapi: 3.1.0 info: title: Tawked API version: 2026-09 summary: >- Tawked Verify: OTP verification for Saudi mobile numbers over SMS, in two calls. Tawked Notifications: WhatsApp template messages from the application's own number. Tawked Email: transactional e-mail from the application's own verified domain. Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and the auto-attendant it sets up there. The Partner API for platforms that run Tawked Verify for their merchants. description: >- The public API of Tawked, a Saudi messaging platform: Tawked Verify (one-time codes), Tawked Notifications (WhatsApp templates from the application's own number), Tawked Email (transactional e-mail from the application's own domain) and the Partner API. Tawked Verify is an OTP verification API for Saudi numbers. One call sends a one-time code by SMS to a Saudi mobile number, and a second call checks it. SAR 0.09 per SMS code sent, prepaid; a send the network refuses is refunded. Authenticate with a Bearer API key from the dashboard (tk_live_ for production, tk_test_ for the sandbox, tk_partner_ for partners, tk_partner_test_ for the partner sandbox). Partners (tk_partner_) provision a Verify application per merchant under /v1/partner/applications and name it as application on every Verify call. Both /v1/... and /api/v1/... answer identically. Rate limit: 120 requests per minute per key. termsOfService: https://tawked.com/en/terms license: name: Proprietary (Tawked terms of service) url: https://tawked.com/en/terms contact: name: Tawked support email: support@tawked.com url: https://tawked.com/en/contact servers: - url: https://tawked.com description: Production (the sandbox is a tk_test_ key on the same host) - url: https://tawked.com/api description: The same API under /api/v1/..., kept for older integrations security: - bearerKey: [] - headerKey: [] tags: - name: Verify x-group: Verify description: Send and check one-time codes. - name: WhatsApp x-group: Notifications description: >- Tawked Notifications: send approved WhatsApp templates through the number connected to an application. An application in review or approved connects its own number from the dashboard. - name: Email x-group: Email description: >- Tawked Email: send transactional e-mail from an address on a verified domain of the application, to up to 50 recipients a message, in batches or scheduled, and read and list what was sent. Live keys only. - name: Chat x-group: Chat description: >- Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and reads, changes and removes, with `chat:menus`; and the application's auto-attendant, which a connected app sets up, publishes and switches on or off, with `chat:attendant`. A connected app's key only; a business adds its own menus and builds its auto-attendant in the console. - name: Partner x-group: Partner API description: >- For platforms that run Tawked Verify for their merchants: provision a Verify application per merchant, keep its brand and verify settings current, switch it off and on, and read usage and the code log. Partner keys (tk_partner_) only; every Verify operation then takes `application` with the partner's own id for the application. - name: Webhooks x-group: Webhooks description: >- The events Tawked sends to your endpoint: an application's verification outcomes and message statuses, and a partner account's lifecycle, balance and opt-in verification events. Every delivery is signed the same way and retried the same way. externalDocs: description: Developer docs, with code samples url: https://docs.tawked.com paths: /v1/email/domains: post: tags: - Email summary: Add a domain description: >- Adds a sending domain to the application and answers its records to put at your DNS host: the DKIM key's TXT record, and the return path's MX and TXT records. Tawked checks them every ten minutes, or at once with `POST /v1/email/domains/{id}/verify`. `201` with the new domain; `200` with the one the application already has. A live key of the application with the explicit `email:manage`: a full-access key does not hold it. At most ten a minute for an application. operationId: email_domain_create parameters: - name: Idempotency-Key in: header required: false description: >- Up to 128 characters. A retry with the same key and the same body within 24 hours answers what the first call answered and changes nothing again; the same key with another body answers `409 idempotency_key_reused`. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: >- The domain, such as `acme.sa`: the business's own, never a public mailbox's (gmail.com and the like) or Tawked's. required: - name responses: '201': description: Added content: application/json: schema: type: object properties: id: type: string name: type: string state: type: string created_at: type: string format: date-time verified_at: type: - string - 'null' pending_until: type: string format: date-time records: type: array items: type: object properties: purpose: type: string type: type: string name: type: string value: type: string state: type: string defaults: type: object properties: from_name: type: string from_local: type: string authentication: type: object properties: dkim: type: string return_path: type: string dmarc: type: string tracking: type: - string - 'null' receiving: type: - string - 'null' examples: added: summary: Added value: id: 0199f1c2-7a41-7c3e-9d2b-5e8f1a2b3c4d name: acme.sa state: pending created_at: '2026-10-23T09:00:00+00:00' verified_at: null pending_until: '2026-10-26T09:00:00+00:00' records: - purpose: dkim type: TXT name: tawked._domainkey.acme.sa value: p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA… state: missing defaults: from_name: متجر أكمي from_local: orders authentication: dkim: pass return_path: working dmarc: none tracking: null receiving: null '400': description: >- `invalid_json`: The request body is not valid JSON.; `invalid_request`: start: `to` (and `phone`) both missing or blank. check: `id` or `code` missing. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - invalid_json - invalid_request '401': description: >- `unauthorized`: Missing, unknown, revoked, or mode-mismatched key; or an unknown/suspended partner.; `key_expired`: The key's `expires_at` has passed. Checked right after the key is recognised, before the IP allowlist or scope. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - unauthorized - key_expired '403': description: >- No email:manage / `live_key_required`: A test (tk_test_) key on a management endpoint: domains, suppressions, metrics and templates are the account's real objects, managed with the application's live key, and received e-mail is read with it too. A test key sends, reads and cancels messages in test mode; a partner's test key (tk_partner_test_) has no e-mail at all.; `application_key_required`: A partner key. Use the application's own key: partner keys manage client applications through the Partner API.; `account_not_active`: The application is not approved yet, the account is banned, or a partner disabled this application. All four causes share this one response.; `ip_not_allowed`: The caller's IP does not match the key's `ip_allowlist` (exact IPs and/or CIDR ranges, IPv4 and IPv6).; `insufficient_scope`: The key was not granted this call: a custom key without this product, or with a level below the call, such as a key that checks where the call sends. The response header `WWW-Authenticate` names the scope the call needs. Judged right after the key is recognised, before `account_not_active` and the request's shape. This operation needs `email:manage`. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - live_key_required - application_key_required - account_not_active - ip_not_allowed - insufficient_scope examples: no_email_manage: summary: No email:manage value: error: insufficient_scope headers: WWW-Authenticate: description: >- Sent with `insufficient_scope` only: the scope this operation needs, which the key was not granted. schema: type: string example: Bearer error="insufficient_scope", scope="email:manage" '409': description: >- Held by another application / `email_access_required`: The account has not asked for Email yet: ask from the application's Email area in the console.; `email_access_pending`: The account's request for Email waits for Tawked's team.; `email_product_off`: The application's Email product is off: turn it on in the console.; `domain_taken`: Another application holds this domain, verified.; `domain_limit`: The application holds its most domains: remove one first. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - email_access_required - email_access_pending - email_product_off - domain_taken - domain_limit examples: held_by_another_application: summary: Held by another application value: error: domain_taken message: Another application holds this domain, verified '422': description: >- A public mailbox domain / `domain_invalid`: Not a domain name.; `domain_public`: A public mailbox's domain (gmail.com, outlook.com and the like) cannot send: use the business's own domain.; `domain_tawked`: Tawked's own domains cannot be added. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - domain_invalid - domain_public - domain_tawked examples: a_public_mailbox_domain: summary: A public mailbox domain value: error: domain_public message: >- A public mailbox's domain cannot send: use the business's own domain '429': description: >- `rate_limited`: The account made its requests for this second: a thousandth of its daily limit, never fewer than 10 a second (10 at the default), counted for all its applications, keys and the SMTP relay together; a batch counts once. Nothing was recorded or charged. `Retry-After: 1`; the `RateLimit-*` headers on every send say where the account stands. On the domain endpoints: an application adds at most ten domains a minute and checks them at most six a minute; `Retry-After` says when to try again.; `too_many_requests`: Per-key rate limit exceeded (default 120 requests/minute, fixed 60s window; 1,200 on the e-mail endpoints). Checked before authentication. The `Retry-After` header gives the seconds to the next window. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - rate_limited - too_many_requests '500': description: >- `internal_error`: An unhandled server error. Quote the X-Request-Id header if you report it. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - internal_error '503': description: >- `email_unavailable`: The sending service cannot be reached now: nothing changed; try again later. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - email_unavailable x-codeSamples: - lang: bash label: cURL source: |- curl -X POST https://tawked.com/v1/email/domains \ -H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "name": "acme.sa" }' - lang: javascript label: Node.js source: |- const res = await fetch("https://tawked.com/v1/email/domains", { method: "POST", headers: { Authorization: "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "acme.sa" }), }); const data = await res.json(); - lang: python label: Python source: |- import requests res = requests.post( "https://tawked.com/v1/email/domains", headers={"Authorization": "Bearer tk_live_xxxxxxxxxxxxxxxxxxxx"}, json={ "name": "acme.sa" }, ) data = res.json() components: schemas: Error: type: object required: - error properties: error: type: string description: A stable machine-readable code; the docs list every one. additionalProperties: true securitySchemes: bearerKey: type: http scheme: bearer description: >- Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret. headerKey: type: apiKey in: header name: x-api-key description: >- The same API key, with the same access, as a header, for clients that cannot set Authorization. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.