Skip to content

Brand

A Brand is a name, a voice, a logo, and a style under which a Startup makes Offers.

Properties

PropertyTypeRequiredDescription
namestringrequiredThe name customers see.
voicetextHow the Brand writes and speaks.
logourlThe logo image.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/brands/brand_1",
  "$type": "Brand",
  "name": "ShiftNote",
  "voice": "Reassuring and direct.",
  "logo": "https://shiftnote.app"
}

Relationships

  • A Brand brands many Offers: each Offer carries exactly one Brand, whose name, voice and logo the buyer sees. brands, inverse brandedBy.
  • A Brand styles many Sites: a Site renders one Brand’s name, voice and Theme. styles, inverse styledBy.
  • A Brand is themed by one Theme: a Theme sets a Brand’s color, type, spacing and motion. themedBy, inverse themes.

Verbs

  1. createCreates a Brand.
    POST /{namespace}/brandsdoBrand.created
  2. getReturns one Brand by id.
    GET /{namespace}/brands/{id}readNo Event
  3. listReturns Brands, newest first, one page at a time.
    GET /{namespace}/brandsreadNo Event
  4. updateChanges the given properties of a Brand.
    PATCH /{namespace}/brands/{id}doBrand.updated
  5. deleteDeletes a Brand; its history is kept.
    DELETE /{namespace}/brands/{id}doBrand.deleted
  6. clearClear checks a proposed Brand name against trademark registers, Domain availability and the Startup’s handles on outside platforms in one call.
    POST /{namespace}/brands/{brand}/cleardoBrand.cleared

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Brand.createYesYesYesNo
Brand.getYesYesYesYes
Brand.listYesYesYesYes
Brand.updateYesYesYesNo
Brand.deleteYesYesYesNo
Brand.clearYesYesYesNo

Call it

Text
Clear my brand.

Example

One Brand can cover two Startups with different Customers. One Startup can sell an Offer under a second Brand for a new audience.