Update workspace brand

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Replaces a brand’s kit and design system. Send the whole brand: design_system replaces the stored one, and leaving it out clears it.

kit.title becomes the brand’s title, and it can’t exactly match another brand’s title in the workspace. kit and design_system are stored as you send them, up to 1 MB together.

Updating doesn’t change the brand’s status. Don’t update a brand while it’s generating, because the finished generation replaces your changes.

This is limited to 60 requests per minute, shared with the other endpoints that change brands, except generating one. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren’t accepted.

The response includes fields beyond the ones documented here. Don’t rely on undocumented response fields, as they can change at any time.

PUT /api/workspace/{workspace_id}/brands/{brand_id}

Update workspace brand

cURL

curl --request PUT \
  --url https://app.base44.com/api/workspace/{workspace_id}/brands/{brand_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kit": {
    "description": "A family furniture workshop that builds solid oak tables and chairs to order.",
    "logo": {
      "altText": "Nordwind logo",
      "url": "https://media.base44.com/images/public/nordwind-logo.png"
    },
    "tagLine": "Furniture built to last",
    "title": "Nordwind",
    "toneOfVoice": [
      "Warm",
      "Plain-spoken"
    ],
    "values": [
      "Craft",
      "Honesty",
      "Durability"
    ]
  },
  "design_system": {
    "tokens": {
      "colors": [
        {
          "label": "Primary",
          "token": "primary",
          "value": "#0B7A3B"
        },
        {
          "label": "Background",
          "token": "background",
          "value": "#FAF7F2"
        }
      ],
      "fonts": [
        {
          "family": "Fraunces",
          "role": "heading"
        },
        {
          "family": "Inter",
          "role": "body"
        }
      ]
    }
  }
}
'

200

{
  "status": "success",
  "message": "Brand 'Nordwind' saved"
}

Authorizations

Authorization · string · header · required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

workspace_id · string · required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

brand_id · string · required

ID of the brand to update. Get it from id in List workspace brands.

Body

application/json

kit · Kit · object · required

The brand's identity. It needs a non-empty title, which becomes the brand's title, and a description. Brands Base44 generates also carry tagLine, values, toneOfVoice, designGuidelines, componentStyle, and a logo with its url. Nothing else in it is checked.

Example:

{
  "description": "A family furniture workshop that builds solid oak tables and chairs to order.",
  "logo": {
    "altText": "Nordwind logo",
    "url": "https://media.base44.com/images/public/nordwind-logo.png"
  },
  "tagLine": "Furniture built to last",
  "title": "Nordwind",
  "toneOfVoice": ["Warm", "Plain-spoken"],
  "values": ["Craft", "Honesty", "Durability"]
}

design_system · Design System · object

The brand's design system: its tokens, such as colors and fonts, and its component sections. It's stored as you send it. When you include tokens, send it as an object. Defaults to an empty object.

Example:

{
  "tokens": {
    "colors": [
      {
        "label": "Primary",
        "token": "primary",
        "value": "#0B7A3B"
      },
      {
        "label": "Background",
        "token": "background",
        "value": "#FAF7F2"
      }
    ],
    "fonts": [
      { "family": "Fraunces", "role": "heading" },
      { "family": "Inter", "role": "body" }
    ]
  }
}

Response

200

application/json

The brand was saved.

Confirms the change.

status · string · required

Always success.

Allowed value: "success"

Example:

"success"

message · string · required

Short confirmation. Its wording can change, so don't parse it.

Example:

"Members added to group."