---
title: "Update the Brand Kit"
method: PATCH
path: "/v1/brand-kit"
tags: ["Brand Kit"]
---

# Update the Brand Kit

`PATCH /v1/brand-kit`

## Request

- Base URL: `https://api.vidocu.ai`
- URL: `https://api.vidocu.ai/v1/brand-kit`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://vidocu.ai/oauth/authorize`, token URL `https://api.vidocu.ai/oauth/token`)

Only the fields you pass change; null clears one. Applies to every future export and article.

**Scope:** `brand_kit:write`

**Role permission:** `canEditSettings` (OAuth only — API keys carry full workspace permissions)

## Request body

- object
  - `companyContext` string, nullable
  - `defaultLanguage` string
  - `defaultVoiceId` string, nullable
  - `openingSceneUrl` string, uri, nullable
  - `closingSceneUrl` string, uri, nullable
  - `backgroundMusicUrl` string, uri, nullable
  - `backgroundMusicVolume` number
  - `backgroundMusicDuckVolume` number
  - `backgroundMusicFadeDuration` number
  - `backgroundMusicPlayInScenes` boolean
  - `defaultVideoBackground` object, nullable
    - `enabled` boolean, required
    - `gradientId` string
    - `gradientColors` string[]
    - `gradientAngle` number
    - `customImageUrl` string, uri
    - `padding` number, required
    - `borderRadius` number, required
  - `defaultSlideStyle` object, nullable
  - `openingSlideDuration` integer, nullable
  - `defaultArticleStyle` object, nullable
  - `defaultAvatarSettings` object, nullable
  - `watermark` object, nullable
    - `enabled` boolean, required
    - `imageUrl` string, uri, required
    - `position` 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right', required
    - `size` 'small' | 'medium' | 'large', required
    - `opacity` number, required
  - `logoUrl` string, uri, nullable
  - `heygenAvatarId` string, nullable
  - `heygenVoiceId` string, nullable

## Response `200`

Success

## Other responses

- `400`: Validation error
- `401`: Invalid or missing credentials
- `403`: Missing scope (`insufficient_scope`), insufficient role (`insufficient_role`), or quota exhausted (`limit_exceeded`)
- `429`: Rate limit exceeded (60 req/min)
- `500`: Server error

---

[API](https://skmtc.dev/vidocu/apis/vidocu-api.md) · [All operations](https://skmtc.dev/vidocu/apis/vidocu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidocu/apis/vidocu-api/revisions/cc813d2ca5d2?raw)