Docs
kirora.ioGet started
Workspaces overviewMenu
On this page

API reference

Workspaces

Partner workspaces let a platform offer messaging to its own customers, one workspace per customer, created and run with a partner key and the Kirora-Workspace header. See Choose an integration.

Endpoints

EndpointRequest
List your tenant workspacesGET /v1/workspaces
Create a tenant workspacePOST /v1/workspaces
Retrieve a tenant workspaceGET /v1/workspaces/{externalId}
Update a tenant workspacePATCH /v1/workspaces/{externalId}
Delete a tenant workspaceDELETE /v1/workspaces/{externalId}
Suspend a tenant workspacePOST /v1/workspaces/{externalId}/suspend
Resume a tenant workspacePOST /v1/workspaces/{externalId}/resume
Cancel a tenant workspace's deletionPOST /v1/workspaces/{externalId}/cancel-deletion

The Workspace object

Workspace example
{
  "id": "0192f3c1-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
  "externalId": "tenant-lagos-01",
  "name": "Juniper Kitchen London",
  "country": "GB",
  "timezone": "Europe/London",
  "status": "active",
  "suspendedAt": null,
  "deletionRequestedAt": null,
  "deletesAt": null,
  "website": "https://juniperkitchen.co.uk",
  "mailKind": "both",
  "contactOptIn": "Order confirmations, and offers to diners who tick the box at checkout",
  "createdAt": "2026-10-01T09:30:00.000Z"
}
idstringrequired

uuid

externalIdstringrequired

Your own id for the tenant.

namestringrequired
countrystringrequired

Two-letter ISO 3166-1 country code.

2 characters

timezonestringrequired

IANA timezone; decides local-time sends and report days.

statusstringrequired

suspended refuses every send in the workspace until it is resumed; deleting refuses them too, and the workspace is purged unless the deletion is cancelled.

one of active, suspended, deleting

suspendedAtstring | nullrequired

When it was suspended; null if not.

date-time

deletionRequestedAtstring | nullrequired

When deletion was asked for; null if not.

date-time

deletesAtstring | nullrequired

When the workspace and everything in it is deleted for good, unless the deletion is cancelled before; null if no deletion is pending.

date-time

websitestring | nullrequired

The business's website.

uri · up to 500 characters

mailKindstring | nullrequired

What the workspace sends.

one of marketing, transactional, both

contactOptInstring | nullrequired

How its contacts agreed to hear from it: a signup form, checkout, an app.

1–1,000 characters

createdAtstringrequired

date-time