brands

Create a brand

Creates the brand and its self entity with one alias (the name) and one domain (the registrable domain of domain), then plants the first cycle so the next sweep measures it.

A caller with no workspace gets one here, on the free tier.

On the free tier the first cycle is the one free measurement, allowed once per registrable domain ever; snapshot says whether it was planned or already_taken. On a weekly plan the first cycle is a scheduled one due now and snapshot is null.

A name of six characters or fewer, or an ordinary English word, is refused with 422 context_terms_required until contextTerms is given — the same rule as a competitor, because the brand's name is its own first alias and the headline mention rate counts it.

post/brands

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/brands
  • Auth: HTTP bearer

Request body

namestring required
domainstring required

A host or URL; reduced to its registrable domain (www.northwind.io/pricing → northwind.io).

timezonestring

IANA zone. Defaults to UTC.

contextTermsstring[]

Words that appear near the name when it means the company, such as a product category. Required when the name is six characters or fewer or an ordinary English word; a mention then counts only near one of them. The brand's domain is added to them.

Example request

{
  "name": "Northwind",
  "domain": "northwind.io",
  "timezone": "Europe/Helsinki",
  "contextTerms": [
    "shared inbox",
    "customer support"
  ]
}

Response

Created.

brandIdstring required
slugstring required

The URL handle, derived from the name. See BrandSummary.

namestring required
domainstring required
timezonestring required
selfEntityIdstring required

The brand's own entity; edit its aliases with PUT /entities/{entityId}.

enginesEngine[] required
snapshot'planned' | 'already_taken' | 'null' nullable required

Free tier only. already_taken means this registrable domain has had its free measurement, in this workspace or another; nothing will run.

Changes

No recorded changes to this operation across all 1 revision of this API.