Skip to content
API docs
Sign inOpen app

Brands

Update a brand

PATCH/v1/brands/{brandId}

Change a brand's name, domains, theme, tracking or Meta token. Each top-level field you send replaces the stored value. Leave out what you don't change.

Path parameters

  • brandIdstringrequired

    The brand's id.

Body

JSON, with Content-Type: application/json.

  • namestring

    The brand's name, such as "Bright Smile Dental".

    1–200 chars

  • domainsarray of string

    Replaces the list. When the first public domain changes, avatarUrl is refetched in the background.

    max 100 items

  • themeobject

    Replaces the stored theme as a whole, so send every value you want to keep.

    Show 13 fields
    • accentstring
    • accentTextstring
    • backgroundstring
    • surfacestring
    • textstring
    • mutedstring
    • borderstring
    • radiusnumber

      0–48

    • buttonRadiusnumber

      0–48

    • fontstring
    • headingFontstring

      max 500 chars

    • backdropstring
    • fontStylesheetstring

      max 2000 chars · uri

  • trackingobject

    Replaces the stored tracking as a whole. Turning on Meta or GA4 needs the plan's tracking feature, and Jornaya needs leadId. TrustedForm needs leadId too, and is in alpha, so other workspaces get 403 feature_unavailable. A missing plan feature answers 403 plan_feature. Anything already on stays on.

    Show 4 fields
    • metaobject
      Show 4 fields
      • enabledboolean
      • pixelIdstring
      • pageViewboolean
      • capiboolean
    • ga4object
      Show 2 fields
      • enabledboolean
      • measurementIdstring
    • jornayaobject
      Show 2 fields
      • enabledboolean
      • campaignKeystring
    • trustedFormobject
      Show 1 field
      • enabledboolean
  • metaCapiTokenstring or null

    The Meta Conversions API access token. It is never returned. Send null to clear it.

Response

  • idstringrequired

    The brand's id.

  • namestringrequired

    The brand's name.

  • domainsarray of stringrequired

    Hostnames the brand's forms may be embedded on. Subdomains match too. An empty list means any site.

  • avatarUrlstring or nullrequired

    The brand's favicon, fetched in the background from its first public domain. It is fetched again when the first public domain changes. Null until there is one, so show initials instead.

  • themeobjectrequired

    The theme values the brand sets. The rest use the defaults.

    Show 13 fields
    • accentstring
    • accentTextstring
    • backgroundstring
    • surfacestring
    • textstring
    • mutedstring
    • borderstring
    • radiusnumber

      0–48

    • buttonRadiusnumber

      0–48

    • fontstring
    • headingFontstring

      max 500 chars

    • backdropstring
    • fontStylesheetstring

      max 2000 chars · uri

  • trackingobjectrequired

    The tracking settings in effect, which are the brand's values on top of the defaults.

    Show 4 fields
    • metaobjectrequired
      Show 4 fields
      • enabledbooleanrequired
      • pageViewbooleanrequired
      • capibooleanrequired
      • pixelIdstring
    • ga4objectrequired
      Show 2 fields
      • enabledbooleanrequired
      • measurementIdstring
    • jornayaobjectrequired
      Show 2 fields
      • enabledbooleanrequired
      • campaignKeystring
    • trustedFormobjectrequired
      Show 1 field
      • enabledbooleanrequired
  • hasMetaCapiTokenbooleanrequired

    Whether a Meta Conversions API token is saved. The token itself is never returned.

  • webhookCountintegerrequired

    How many webhooks the brand has, its own and its forms', counted up to 100. GET /v1/webhooks lists them.

    -9007199254740991–9007199254740991

  • starterbooleanrequired

    True for a guest's starter brand, which has no website or name yet. False for every other brand.

  • createdAtnumberrequired

    When the brand was made, in milliseconds since the epoch.

  • workspaceIdstringrequired

    The workspace the brand belongs to.

Errors answer with a status and the error shape.