Skip to content

by Startups.Studio

Product Brand Brand

Brand.update

PATCH /{namespace}/brands/{id}

Changes the given properties of a Brand.

Noun: Brand
Mode: do
Event: Brand.updated

You, to your agent

Change the brand “Kiln Bakery”.

curl -X PATCH https://api.sb/kilnbakery.com/brands/brand_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Kiln Bakery"}'

import { $ } from 'startup-builder'

const brand = await $.Brand.update({ id: 'brand_1', name: 'Kiln Bakery' })

npx startup-builder do Brand.update --json '{"id":"brand_1","name":"Kiln Bakery"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Brand.update({ id: 'brand_1', name: 'Kiln Bakery' })"
  }
}

Update changes the given properties of a Brand. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Brand.
`name`	`string`		The name customers see.
`voice`	`text`		How the Brand writes and speaks.
`logo`	`url`		The logo image.

Outputs

Output	Type	Required	Description
`brand`	Brand	required	The Brand.

Effects

Emits Brand.updated.
Two-way: try, send, do.

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.update

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.list

Previous Page

Theme

Next Page