Documentation

White-label and branding

Understand widget branding controls and verify white-label availability before configuring client-facing bots.

The app exposes a white-label API resource and a widget setting for branding visibility. This frontend repository does not define the full white-label field schema, plan entitlements, or contractual terms. Confirm those details in your account and current plan before promising a fully unbranded experience.

Review branding settings

Widget configuration includes show_branding, and the API client exposes GET and PUT /white-label. Use the dashboard's current settings to see which options are available to your account. Do not send guessed fields to the white-label endpoint; the editable schema is not documented in this repository.

Check the public widget, chat page, emails, and any client handoff experience separately. A single widget setting may not control branding in every surface. If you manage bots for clients, document which parts are customized and which still identify the service provider.

Protect client and account boundaries

Keep each client's credentials separate, grant only the access needed to manage its bot, and avoid sharing a global API key. Confirm ownership and data-handling terms with the client before adding their content or publishing an embedded widget.

Inspect widget branding configuration

curl --request GET "$PRIMEWEBKIT_API_URL/bots/$BOT_ID/widget" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $PRIMEWEBKIT_ACCESS_TOKEN"

# The widget configuration type includes a show_branding boolean.
# Confirm plan eligibility and verify the result in the live widget.

Safe deployment checklist

Client approval:       required before publishing
Bot ownership:         confirmed
Allowed domains:       limited to approved hostnames
Credential storage:    server-side, least privilege
Branding claims:       checked against current plan and terms

Frequently asked questions

Does PrimeWebKit offer full white-labeling on every plan?

Plan eligibility and full white-label scope are not documented in this repository. Verify the current account controls, plan terms, and contract before promising it.

What does the show_branding setting control?

It is a boolean field in the widget configuration. The exact surfaces it affects and plan requirements should be verified in the current product.

Can I configure the white-label endpoint directly?

The frontend API client exposes GET and PUT /white-label, but this repository does not define the accepted fields. Use the dashboard or obtain the current API schema rather than sending guessed values.