Affecter un agent à une zone à la main

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

Autorisation

Rôle dans l’organisation	Ce point de terminaison
owner	Autorisé
admin	Autorisé
editor	Non autorisé
viewer	Non autorisé

Une clé porte le rôle que son propriétaire détient dans l’organisation. Voir Authentification.

Portée de clé d’API : zones:write

Paramètres de chemin

Paramètre	Type	Description
agent_id	string	Obligatoire.

Paramètres d’en-tête

Paramètre	Type	Description
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.

Corps de la requête

Champ	Type	Description
zone_id	string (uuid)	Obligatoire.

Réponse

• 200 OK — l’appel a réussi.
• 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

Champs de la réponse

Champ	Type	Description
assignment_source	string	Obligatoire.
zone_id	string or null	Obligatoire.

Exemple de réponse

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

Voir aussi

• DELETE Rétablir l’affectation automatique de zone d’un agent
• GET Ce qui s’applique à cet agent
• GET Lister les unités organisationnelles de l’organisation