brands

Rename a brand or change its timezone

name is the display name; matching uses the self entity's aliases, edited on the entity. timezone moves the day boundary for cycles and rollups from the next cycle on; history is not recomputed. The domain cannot change — it defines the self entity — so a new domain is a new brand.

patch/brands/{brandId}

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/brands/{brandId}
  • Auth: HTTP bearer

Request body

namestring
timezonestring

IANA zone.

Example request

{
  "timezone": "Europe/Helsinki"
}

Response

The brand.

brandIdstring required
role'viewer' | 'editor' | 'admin' | 'owner' required

The caller's role on this brand: owner for the workspace's owner, else the role they were given on it. Reads need viewer, writes editor.

slugstring required

The URL handle: the dashboard is at /brands/{slug}. From the name at creation; stable across renames; accepted wherever {brandId} is.

namestring required
domainstring required

Registrable domain, lowercase.

timezonestring required

IANA zone; day boundaries for cycles and rollups.

createdAtstring date-time required
activePromptsinteger required
competitorsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.