Partners

Delete a tenant's workspace

DELETE/v1/workspaces/{externalId}

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

Partner keys only. Sending stops at once (403 WORKSPACE_DELETION_PENDING, queued messages skipped) and the status becomes deleting. After the grace period, 14 days from deletionRequestedAt by default, the workspace and everything in it (contacts, history, files, sending domains) is deleted for good. Cancel before then with POST /v1/workspaces/{externalId}/cancel-deletion. Asking twice keeps the first time.

Path parameters

externalIdstringrequired

Returns

Returns 200 OK 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 DELETE https://api.kirora.io/v1/workspaces/user_8812 \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/workspaces/user_8812', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.delete(
    "https://api.kirora.io/v1/workspaces/user_8812",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

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

func main() {
	req, err := http.NewRequest("DELETE", "https://api.kirora.io/v1/workspaces/user_8812", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	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 · 200

{
  "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.