---
title: "Update white-label settings"
method: POST
path: "/update-white-label"
tags: ["Chatbot Operations"]
---

# Update white-label settings

`POST /update-white-label`

## Request

- Base URL: `https://api.chat-data.com/api/v2`
- URL: `https://api.chat-data.com/api/v2/update-white-label`
- Auth: HTTP bearer

This API endpoint allows you to update white label settings for your chatbot. Only the fields you send are changed.

`showPowerby`, `powerbyText`, `company` and `companyUrl` require your [plan](/pricing) to include Remove Brand or Remove Label. `embeddingDomain` and `fromEmail` require Remove Brand. Sending a field your plan does not include returns a 403.

## Request body

- object
  - `chatbotId` string, required: The ID of the chatbot to update.
  - `showPowerby` boolean: Whether to show the "Powered by" text.
  - `powerbyText` string: Custom "Powered by" text.
  - `company` string: Company name for white labeling.
  - `companyUrl` string: Company URL for white labeling.
  - `embeddingDomain` string: Custom domain for embedding the chatbot, with or without `https://`. Its DNS must be unused or already point to `www.chat-data.com`. The response lists the DNS records to add.
  - `fromEmail` string: Custom sender address for emails to your users. The response lists the DNS records that verify its domain. Set it to `admin@chat-data.com` to go back to the default sender.

## Response `200`

Successful response.

- object
  - `status` string: Response status indicator.
  - `domainDnsRecords` object[]: DNS records required for custom domain setup. Only returned when `embeddingDomain` is provided.
    - `type` string: Type of DNS record.
    - `host` string: Hostname to configure.
    - `data` string: Value for the DNS record.
    - `status` boolean: Whether the DNS record is properly configured.
  - `emailDnsRecords` object[]: DNS records required for custom email setup. Only returned when `fromEmail` is provided.
    - `type` string: Type of DNS record (for example CNAME or TXT).
    - `host` string: Hostname to configure.
    - `data` string: Value for the DNS record.
    - `status` boolean: Whether the DNS record is properly configured.

## Other responses

- `400`: The settings could not be saved. For example: `embeddingDomain` starts with `http://` or `https://` but is not a valid URL, its DNS already points to another server, `fromEmail` is not a valid email address, or `fromEmail` uses a Chat Data domain.
- `401`: Authentication failed: the `Authorization` header is missing or not in the `Bearer <key>` format, the API key does not exist, its workspace is unavailable or has no owner, or the workspace's plan does not include API access. `message` says which.
- `403`: The API key cannot access the requested chatbot. A chatbot-scoped key used with another chatbot's ID gets `Access denied to this chatbot`. A workspace key gets `Chatbot <id> was not found in this API key's workspace. It may have been deleted or moved to another workspace.` when the chatbot does not exist or belongs to another workspace. Also returned when the plan does not include the requested change: `You do not have permission to update white label settings. Please upgrade your plan to access these features.` for `showPowerby`, `powerbyText`, `company` or `companyUrl`, and `You do not have permission to customize domain or email settings. Please upgrade your plan to access these features.` for `embeddingDomain` or `fromEmail`.
- `404`: `chatbotId` was not provided.
- `429`: The workspace sent more than 600 API requests in the last minute (wait the seconds in `Retry-After`), or it set up more than 20 new sender domains for `fromEmail` in the last hour. The sender-domain response also carries the wait in seconds as `retryAfter`.
- `500`: The sender-domain rate limiter for `fromEmail` is temporarily unavailable. This response is the server's default error page, not JSON.

---

[API](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide.md) · [All operations](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/llms.txt) · [OpenAPI document](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/revisions/72871007f7f0?raw)