Asignar un agente a una zona a mano

PUT/api/public/v1/agents/{agent_id}/zone

Sets zone_override_id, so directory sync stops moving this agent — exactly as ownership already behaves once set by hand. An unknown or retired zone answers 422, not 404: the AGENT exists, the body's zone_id is what is unacceptable.

cURL

curl --fail-with-body -X PUT 'https://app.openlatch.ai/api/public/v1/agents/<agent_id>/zone' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"zone_id":"<zone_id>"}'

Python

import json
import os
import urllib.request

body = '{"zone_id":"<zone_id>"}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/agents/<agent_id>/zone',
    method='PUT',
    data=body.encode(),
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
        'Content-Type': 'application/json',
    },
)
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/agents/<agent_id>/zone' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"zone_id":"<zone_id>"}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"zone_id":"<zone_id>"}'
Invoke-RestMethod -Method PUT -Uri 'https://app.openlatch.ai/api/public/v1/agents/<agent_id>/zone' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | 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
agent_id	string	Obligatorio.

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.

Cuerpo de la solicitud

Campo	Tipo	Descripción
zone_id	string (uuid)	Obligatorio.

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
• 409 Conflict — IDEMPOTENCY_IN_PROGRESS
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, VALIDATION_ERROR, ZONE_UNAVAILABLE
• 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
assignment_source	string	Obligatorio.
zone_id	string or null	Obligatorio.

Ejemplo de respuesta

{
  "assignment_source": "string",
  "zone_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10"
}

Véase también

• DELETE Restablecer la asignación automática de zona de un agente
• GET Lo que se aplica a este agente
• GET Listar las unidades organizativas de la organización