Set a policy's Ask delivery and Ask behaviour

PATCH/api/public/v1/policies/{public_id}/ask-settings beta

ask_mode_override: platform | agent | both, or null to follow the zone. ask_behaviour_override: pass_and_review | hold_until_validated, or null to follow the zone. Each wins over every zone in the chain and applies to every intent policy of the AIP; a field that is not sent is left as it is. 409 INHERITED_HERE from a zone that inherits the policy, 409 NOT_RATIFIED for a draft or retired one.

cURL

curl --fail-with-body -X PATCH 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/ask-settings' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"ask_behaviour_override":"pass_and_review"}'

Python

import json
import os
import urllib.request

body = '{"ask_behaviour_override":"pass_and_review"}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/ask-settings',
    method='PATCH',
    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 PATCH 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/ask-settings' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"ask_behaviour_override":"pass_and_review"}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"ask_behaviour_override":"pass_and_review"}'
Invoke-RestMethod -Method PATCH -Uri 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/ask-settings' -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	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 : policies:write

Paramètres de chemin

Paramètre	Type	Description
public_id	string	Obligatoire.

Paramètres de requête

Paramètre	Type	Description
zone_id	string (uuid) or null

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
ask_behaviour_override	string — one of pass_and_review, hold_until_validated or null
ask_mode_override	string — one of platform, agent, both or null

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, INHERITED_HERE, NOT_RATIFIED
• 422 Unprocessable Content — EMPTY_PATCH, 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

Champs de la réponse

Champ	Type	Description
data	object	Obligatoire.
data.ask_behaviour_override	string or null
data.ask_mode_override	string or null
data.effective_ask_behaviour	string	Obligatoire.
data.effective_ask_mode	string	Obligatoire.
data.public_id	string	Obligatoire.

Exemple de réponse

{
  "data": {
    "ask_behaviour_override": "string",
    "ask_mode_override": "string",
    "effective_ask_behaviour": "string",
    "effective_ask_mode": "string",
    "public_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10"
  }
}

Voir aussi

• POST State sentences as a policy
• DELETE Delete a policy
• GET Lire une politique ratifiée