Brand routes: update, delete

Reference for Brand, one group of Brand routes.

Brand.update

Changes the given properties of a Brand. Verb page.

Text

PATCH /{namespace}/brands/{id}

Path: id. Body, as JSON: the other inputs. Emits Brand.updated.

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.

Returns

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

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

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/brands/brand_PluVQrB1HF \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "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.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Brand.delete

Deletes a Brand: a soft delete that keeps its history, undone by Thing.restore. Verb page.