Update Design Kit

PATCH 
/brand-boards/locations/:locationId/design-kits/:designKitId

Update a design kit by ID

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

ID of the location that owns the design kit.

designKitId stringrequired

ID of the design kit to update.

application/json

application/json

Body

Bodyrequired

namestring

Display name for the design kit.

logosobject[]

Logos for the design kit. Sending this field replaces the existing logos. To keep an existing logo, include it with its id.

colorsobject[]

Colors for the design kit. Sending this field replaces the existing colors. To keep an existing color, include it with its id.

fontsobject[]

Fonts for the design kit. Sending this field replaces the existing fonts. To keep an existing font, include it with its id.

Example (auto)

{
  "name": "My Design Kit",
  "logos": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3c9",
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo"
    }
  ],
  "colors": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3ca",
      "value": "#FF5733",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3cb",
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ]
}

application/json

Success

application/json

Schema

Schema

idstringrequired

Unique identifier of the design kit.

namestringrequired

Display name of the design kit.

isDefaultbooleanrequired

Whether this is the default design kit for the location.

createdAtstringrequired

ISO 8601 timestamp of when the design kit was created.

updatedAtstringrequired

ISO 8601 timestamp of when the design kit was last updated.

locationIdstringrequired

ID of the location that owns the design kit.

deletedbooleanrequired

Whether the design kit has been soft-deleted.

logosobject[]

Logos belonging to the design kit.

colorsobject[]

Colors belonging to the design kit.

fontsobject[]

Fonts belonging to the design kit.

traceIdstring

Trace identifier for the request, useful for debugging and support.

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "name": "My Design Kit",
  "isDefault": false,
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z",
  "locationId": "oHJiAh0wDG3BzmzACVD6",
  "deleted": false,
  "logos": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3c9",
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo"
    }
  ],
  "colors": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3ca",
      "hex": "#FF5733",
      "hexa": "#FF5733FF",
      "rgb": "rgb(255, 87, 51)",
      "rgba": "rgba(255, 87, 51, 1)",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "id": "6a1d1e5db5ef0dfa799ed3cb",
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}