Chatbot Operations

Update white-label settings

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 to include Remove Brand or Remove Label. embeddingDomain and fromEmail require Remove Brand. Sending a field your plan does not include returns a 403.

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

Request body

chatbotIdstring required

The ID of the chatbot to update.

showPowerbyboolean

Whether to show the "Powered by" text.

powerbyTextstring

Custom "Powered by" text.

companystring

Company name for white labeling.

companyUrlstring

Company URL for white labeling.

embeddingDomainstring

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.

fromEmailstring

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.

Example request

{
  "chatbotId": "6650f1c2a9e4b83d2c7a1f05",
  "powerbyText": "Powered by Example Inc",
  "company": "Example Inc",
  "companyUrl": "https://www.example.com",
  "embeddingDomain": "chat.example.com",
  "fromEmail": "support@example.com"
}

Response

Successful response.

statusstring

Response status indicator.

Example response

{
  "status": "success",
  "domainDnsRecords": [
    {
      "type": "cname",
      "host": "_acme-challenge.chat.example.com",
      "data": "chat.example.com.e7c5afd44f1a18fb.dcv.cloudflare.com",
      "status": true
    },
    {
      "type": "cname",
      "host": "chat.example.com",
      "data": "www.chat-data.com",
      "status": true
    }
  ],
  "emailDnsRecords": [
    {
      "type": "cname",
      "host": "k7q2m4._domainkey.example.com",
      "data": "k7q2m4.dkim.amazonses.com",
      "status": true
    },
    {
      "type": "cname",
      "host": "p3x8w1._domainkey.example.com",
      "data": "p3x8w1.dkim.amazonses.com",
      "status": true
    },
    {
      "type": "cname",
      "host": "r9d5t6._domainkey.example.com",
      "data": "r9d5t6.dkim.amazonses.com",
      "status": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.