v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB

Tenants

Create or Update Tenant

Idempotently creates or updates a tenant. Required before associating destinations.

put/tenants/{tenant_id}

Request body

metadataobject nullable

Optional key/value metadata to store with the tenant.

Response

Tenant updated details.

idstring

User-defined system ID for the tenant.

destinations_countinteger

Number of destinations associated with the tenant.

topicsstring[]

List of subscribed topics across all destinations for this tenant.

metadataobject nullable

Arbitrary key-value pairs for storing contextual information about the tenant.

created_atstring date-time

ISO Date when the tenant was created.

updated_atstring date-time

ISO Date when the tenant was last updated.

Example response

{
  "id": "123",
  "destinations_count": 5,
  "topics": [
    "user.created",
    "user.deleted"
  ],
  "metadata": {
    "name": "Acme Inc."
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}