Skip to content

by Startups.Studio

Product Brand Brand

Brand.clear

POST /{namespace}/brands/{brand}/clear

Clear checks a proposed Brand name against trademark registers, Domain availability and the Startup’s handles on outside platforms in one call.

Noun: Brand
Mode: do
Event: Brand.cleared

You, to your agent

Clear my brand.

curl -X POST https://api.sb/petpantry.shop/brands/brand_1/clear \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { verdict, findings, brand } = await $.Brand.clear({ brand: 'brand_1' })

npx startup-builder do Brand.clear --json '{"brand":"brand_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Brand.clear({ brand: 'brand_1' })"
  }
}

Inputs

Input	Type	Required	Description
`brand`	Brand	required	The Brand whose name to check.
`markets`	list of Market		The Markets whose registers to search. Defaults to the Startup’s Markets.
`classes`	`integer[]`		Trademark classes. Defaults to the classes of the Startup’s Products.

Outputs

Output	Type	Required	Description
`verdict`	`string`	required	`clear` lets the name ship, `conflict` blocks it, `review` waits for the Legal Lead.
`findings`	`json`	required	Each similar mark, taken Domain or taken handle, with the register or platform it was found on.
`brand`	Brand	required	The Brand whose name was checked.

Effects

Emits Brand.cleared.
Performed by the Legal Lead.
Two-way: it runs at once, in the try, send and do modes.
Refuses Site.publish under a Brand whose latest verdict is conflict.
Opens an Approval for the Legal Lead on review.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Brand.clear

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Brand

Previous Page

Brand.create

Next Page