Skip to main content
PATCH
/
tenants
/
{tenantId}
cURL
curl -X PATCH "https://api.arkhq.io/v1/tenants/cm6abc123def456" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "metadata": {
      "plan": "enterprise",
      "internal_id": "cust_12345"
    }
  }'
{
  "success": true,
  "data": {
    "id": "cm6abc123def456ghi789",
    "name": "Acme Corp",
    "metadata": {
      "plan": "pro",
      "internalId": "cust_12345"
    },
    "status": "active",
    "createdAt": "2026-02-03T10:30:00Z",
    "updatedAt": "2026-02-03T10:30:00Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
tenantId
string
required

The tenant ID

Body

application/json
​
name
string

Display name for the tenant

Required string length: 1 - 100
Example:

"Acme Corporation"

​
metadata
object

Custom key-value pairs. Useful for storing references to your internal systems.

Limits:

  • Max 50 keys
  • Key names max 40 characters
  • String values max 500 characters
  • Total size max 8KB
Example:
{
  "plan": "pro",
  "internalId": "cust_12345",
  "region": "us-west"
}
​
status
enum<string>

Tenant status

Available options:
active,
suspended,
archived
Example:

"active"

Response

Tenant updated

​
success
boolean
required
​
data
object
required
​
meta
object
required