Skip to main content
POST
Create a brand asset

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: 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

Upload request for a new asset.

kind
enum<string>
required

Asset kind.

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

Image type (SVG is not accepted).

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

File size: at most 2 MiB (hero at most 5 MiB).

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

SHA-256 of the file (64 lower-case hex characters).

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

Response

Created

Single-object envelope around a BrandAsset.

data
object
required

An image used by branding and email templates.