Skip to content
API docs
Sign inOpen app

Brands

Create from a website

POST/v1/brands/from-site

Create a brand from a website read. It is named after the site, using the suggested brand name or else the address. It lists the site's domains, with and without www. for a main address. It takes the site's look when that is ready, and the default look until then. If a brand you can see already lists the site's address, that brand is returned and nothing is created. Like POST /v1/brands, it fails with 403 plan_limit past the plan's brand limit, and fills in a guest's one brand instead.

Body

JSON, with Content-Type: application/json.

  • readIdstringrequired

    The read's id from POST /v1/sites/read. A read still in progress fills in the brand's look and name when they land, unless the brand has its own by then.

    1–64 chars

  • workspaceIdstring

    Optional. Your API key already belongs to one workspace.

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.