Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductBrandBrand

Brand routes: clear

The Brand Verbs clear as api.sb routes, with inputs, result, refusals and an example.

Reference for Brand, one group of Brand routes.

Brand.clear

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

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

Path: brand. Body, as JSON: the other inputs. Emits Brand.cleared.

Inputs

InputTypeRequiredDescription
brandBrandrequiredThe Brand whose name to check.
marketslist of MarketThe Markets whose registers to search. Defaults to the Startup’s Markets.
classesinteger[]Trademark classes. Defaults to the classes of the Startup’s Products.

Returns

OutputTypeRequiredDescription
verdictstringrequiredclear lets the name ship, conflict blocks it, review waits for the Legal Lead.
findingsjsonrequiredEach similar mark, taken Domain or taken handle, with the register or platform it was found on.
brandBrandrequiredThe Brand whose name was checked.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/brands/brand_PluVQrB1HF/clear \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "verdict": "clear",
  "findings": {},
  "brand": {
    "$id": "https://api.sb/leaseline.app/brands/brand_PluVQrB1HF",
    "$type": "Brand",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Brand.clear",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Theme

Next