Skip to main content
POST
Create a brand asset

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

Request an upload target for a workspace image.

kind
enum<string>
required

Asset kind. Treat as an open set: new values may be added.

Available options:
logo,
logo-dark,
icon,
hero,
favicon,
email-logo
contentType
enum<string>
required

SVG is not accepted. Treat as an open set: new values may be added.

Available options:
image/png,
image/jpeg,
image/webp
sizeBytes
integer
required

Up to 2 MiB (hero 5 MiB).

Required range: 1 <= x <= 5242880
sha256
string
required

Hex SHA-256.

Pattern: ^[0-9a-f]{64}$

Response

Success.

Single-object envelope around BrandAsset.

data
object
required

An uploaded image.