Skip to main content
PATCH
Update a tenant

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Path Parameters

tenantSlug
string
required
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

name
string
Required string length: 1 - 100
slug
string
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
metadata
object

Free-form data, e.g. your own customer id

settings
object

Structured tenant settings — validated against the settings catalog

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required