PATCH /v1/me/domains/{domain}

Family: Workspace account · Operation ID: v1_update_tenant_domain

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Manage workspace domains

Required scope: settings

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X PATCH "$API_BASE_URL/v1/me/domains/{domain}" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Replace each {parameter} segment in the path with its URL-encoded value.

Parameters

[
  {
    "description": "Domain identifier",
    "in": "path",
    "name": "domain",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request body · application/json

{
  "$ref": "#/components/schemas/UpdateTenantDomainRequest",
  "definition": {
    "properties": {
      "domain": {
        "nullable": true,
        "type": "string"
      },
      "is_active": {
        "nullable": true,
        "type": "boolean"
      },
      "is_verified": {
        "nullable": true,
        "type": "boolean"
      },
      "notes": {
        "nullable": true,
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200

{
  "description": "Tenant domain updated"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract