Skip to main content
PUT
/
v1
/
api
/
business-profile
Update business profile
curl --request PUT \
  --url https://api.hq.zone/v1/api/business-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand_palette": "<unknown>",
  "business_domain": "<string>",
  "fonts": "<unknown>",
  "logo_url": "<string>",
  "summary": "<string>"
}
'
{
  "detected": [
    {
      "signal_type": "<string>",
      "value": "<string>"
    }
  ],
  "overridden": [
    "<string>"
  ],
  "brand_palette": "<unknown>",
  "business_domain": "<string>",
  "crawl_domain": "<string>",
  "crawl_status": "<string>",
  "dm_sent_at": "2023-11-07T05:31:56Z",
  "enrichment": {
    "enriched_at": "2023-11-07T05:31:56Z",
    "industry": "<string>",
    "segment": "<string>",
    "size_hint": "<string>"
  },
  "fetched_at": "2023-11-07T05:31:56Z",
  "fonts": "<unknown>",
  "last_error": "<string>",
  "logo_artifact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "logo_url": "<string>",
  "pages_crawled": 123,
  "summary": "<string>",
  "summary_confidence": 123
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json
brand_palette
any
business_domain
string | null

Set or clear the crawled domain. Setting to a different value than current also enqueues an immediate refresh; this is the admin-edit-domain path.

fonts
any
logo_url
string | null
summary
string | null

Admin-supplied summary override. When set, the next agent turn reads this instead of the crawler's output.

Response

Updated profile

detected
object[]
required

Technology signals detected for the tenant, highest-confidence first. Powers the read-only "Detected technology" section.

overridden
string[]
required

Which fields are currently admin-overridden. Powers the "Use auto" affordance in the UI - only the overridden fields get a reset-button.

brand_palette
any
business_domain
string | null

Currently-set domain on the tenants row. May differ from crawl.domain if the admin changed it after the last crawl.

crawl_domain
string | null
crawl_status
string | null
dm_sent_at
string<date-time> | null
enrichment
object

Company enrichment learned by profiling (migration 0155). None when none of industry/segment/size_hint are set.

fetched_at
string<date-time> | null
fonts
any
last_error
string | null
logo_artifact_id
string<uuid> | null
logo_url
string | null
pages_crawled
integer<int32> | null
summary
string | null
summary_confidence
number<float> | null