Partners

Create a workspace for one of your tenants

POST/v1/workspaces

Requires an API key with the workspaces:manage scope. About keys and scopes

Partner keys only. Creates a child workspace for one tenant of your product, identified by your own externalId, so you never need to store ours. From then on, any /v1 call with the header Kirora-Workspace: <externalId> acts in that workspace with your key: load its contacts, verify its sending domain, send. The workspace has no members and bills to your account. A repeated externalId is 409 ALREADY_EXISTS. While your own workspace is being deleted this is 403 WORKSPACE_DELETION_PENDING; cancel the deletion to create workspaces again.

Request body

namestringrequired

1–200 characters

externalIdstringrequired

Your own id for the tenant (up to 128 letters, digits, ., :, _, -); unique among your workspaces.

countrystringrequired

Two-letter ISO 3166-1 country code.

timezonestringoptional

IANA timezone, such as Europe/Berlin.

1–64 characters

Returns

Returns 201 Created with a Workspace in data. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

externalIdstringrequired

Your own id for the tenant.

namestringrequired

countrystringrequired

Two-letter ISO 3166-1 country code.

2–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

createdAtstringrequired

date-time

curl -X POST https://api.kirora.io/v1/workspaces \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekend specials",
    "externalId": "user_8812",
    "country": "GB"
  }'

const response = await fetch('https://api.kirora.io/v1/workspaces', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Weekend specials",
    "externalId": "user_8812",
    "country": "GB"
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/workspaces",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "name": "Weekend specials",
        "externalId": "user_8812",
        "country": "GB",
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "name": "Weekend specials",
	  "externalId": "user_8812",
	  "country": "GB"
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/workspaces", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 201

{
  "data": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "externalId": "user_8812",
    "name": "Weekend specials",
    "country": "GB",
    "timezone": "Europe/London",
    "status": "active",
    "suspendedAt": "2030-03-14T09:30:00Z",
    "deletionRequestedAt": "2030-03-14T09:30:00Z",
    "createdAt": "2030-03-14T09:30:00Z"
  }
}

Example values are generated from the schema.