Make a zone the organization's default zone

PUT/api/public/v1/zones/{zone_id}/default

The default zone serves agents with no resolved owner and no manual assignment, existing ones included; the root serves when none is chosen. Swapping clears the previous default in the same transaction. dry_run=true answers moving — the agents whose zone would change — and writes nothing. PUT on the root clears any default; on the zone that already is the default it is a no-op answering moving: 0.

cURL

curl --fail-with-body -X PUT 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/default' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY"

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/default',
    method='PUT',
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X PUT 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/default' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
Invoke-RestMethod -Method PUT -Uri 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/default' -Headers $headers | ConvertTo-Json -Depth 20

Autorización

Rol en la organización	Este punto de conexión
owner	Permitido
admin	Permitido
editor	No permitido
viewer	No permitido

Una clave tiene el rol que su propietario ocupa en la organización. Consulte Autenticación.

Ámbito de la clave de API: zones:write

Parámetros de ruta

Parámetro	Tipo	Descripción
zone_id	string (uuid)	Obligatorio.

Parámetros de consulta

Parámetro	Tipo	Descripción
dry_run	boolean	Count the agents that would move and change nothing.

Parámetros de encabezado

Parámetro	Tipo	Descripción
Idempotency-Key	string or null	Optional. Makes the request safe to retry: the same key and the same request, within 24 hours, returns the stored response with Idempotent-Replayed: true and runs once.

Respuesta

• 200 OK — la llamada se completó correctamente.
• 400 Bad Request — BAD_REQUEST
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND, ZONE_NOT_FOUND
• 409 Conflict — DEFAULT_CONFLICT, IDEMPOTENCY_IN_PROGRESS
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, VALIDATION_ERROR
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Campos de la respuesta

Campo	Tipo	Descripción
moving	integer	Obligatorio.

Ejemplo de respuesta

{
  "moving": 3
}

Véase también

• DELETE Restablecer la asignación automática de zona de un agente
• GET Lo que se aplica a este agente
• PUT Asignar un agente a una zona a mano