WHwhop
Accounts

Retrieve Account Customer Tracking

Changed on

Retrieves the branding and support contacts the account's hosted customer tracking page and tracking Element display. Public by design, so no authentication is required. Returns 404 unless the account has turned customer tracking on in its preferences. Responses are never cached.

get/accounts/{account_id}/customer_tracking

Request

  • Base URL
    https://api.whop.com/api/v1
  • URL
    https://api.whop.com/api/v1/accounts/{account_id}/customer_tracking
  • Auth
    none required

Response

customer tracking retrieved

accent_colorstring required

Accent color, as a #rrggbb hex color.

business_namestring required

The business name shown on its customer tracking page.

button_text_color'black' | 'white' required

black or white, whichever reads against the accent color.

logo_urlstring nullable required

The account logo image URL, or null when it has not uploaded one.

show_business_nameboolean required

Whether to display the business name on the tracking page and Element.

show_logoboolean required

Whether to display the logo on the tracking page and Element.

support_emailstring nullable required

Customer support email address, or null when not set.

support_urlstring nullable required

HTTPS customer support URL, or null when not set.

Example response

{
  "accent_color": "#1d4ed8",
  "business_name": "Shine Time Auto Detailing",
  "button_text_color": "white",
  "show_business_name": true,
  "show_logo": true
}

Changes