Skip to main content
POST
/
update-evaluator
Update Evaluator
curl --request POST \
  --url https://api.heify.com/update-evaluator \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "evaluator_id": "cd9e6ef7-fd3c-4cf1-9dd5-a5d5dbc8e887",
  "description": "descripcion cambiada",
  "language": "eu",
  "context": "cambiado",
  "criteria": [
    {
      "id": "141aceae-9fe2-4e55-80c7-707b0aeb9bff",
      "name": "Saludo Corporativodf",
      "description": "El agente debe presentarse con su nombre completo, indicar el nombre de la empresa y dar la bienvenida al cliente.",
      "type": "scale",
      "weight": 54
    },
    {
      "id": "a2b542de-a06a-44ea-9975-20cab95ccaa8",
      "name": "Verificación de Identidad",
      "description": "El agente debe verificar la identidad del cliente solicitando al menos dos datos personales.",
      "type": "strict",
      "weight": 0
    },
    {
      "id": "228dc9a9-30a4-447a-9b0e-7ef01904fc2c",
      "name": "Empatía",
      "description": "El agente muestra comprensión ante la situación del cliente.",
      "type": "boolean",
      "weight": 42
    },
    {
      "name": "New Criterion",
      "description": "New criterion added during update — no id provided.",
      "type": "boolean",
      "weight": 4
    }
  ]
}
'
{
  "data": {
    "message": "Evaluator updated successfully",
    "evaluator": {
      "evaluator_id": "cd9e6ef7-fd3c-4cf1-9dd5-a5d5dbc8e887",
      "tag": "nombree",
      "description": "descripcion cambiada",
      "language": "eu",
      "context": "cambiado",
      "criteria": [
        {
          "id": "141aceae-9fe2-4e55-80c7-707b0aeb9bff",
          "name": "Saludo Corporativodf",
          "description": "El agente debe presentarse con su nombre completo, indicar el nombre de la empresa y dar la bienvenida al cliente.",
          "type": "scale",
          "weight": 54
        },
        {
          "id": "a2b542de-a06a-44ea-9975-20cab95ccaa8",
          "name": "Verificación de Identidad",
          "description": "El agente debe verificar la identidad del cliente solicitando al menos dos datos personales.",
          "type": "strict",
          "weight": 0
        },
        {
          "id": "228dc9a9-30a4-447a-9b0e-7ef01904fc2c",
          "name": "Empatía",
          "description": "El agente muestra comprensión ante la situación del cliente.",
          "type": "boolean",
          "weight": 42
        },
        {
          "id": "932f8c81-044e-405e-8a9c-493003e1f4e5",
          "name": "New Criterion",
          "description": "New criterion added during update — no id provided.",
          "type": "boolean",
          "weight": 4
        }
      ],
      "created_at": "2026-03-21T15:50:25.898670+00:00"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.heify.com/llms.txt

Use this file to discover all available pages before exploring further.

Criteria not included in the request will be permanently deleted. Always send the full list of criteria you want to keep, not just the changes. See Evaluator — criteria.
tag cannot be changed after creation.
To update an existing criterion, include its id. To add a new one, omit id. Providing an id that does not belong to this evaluator returns 400.
Non-strict criteria weights must still sum to exactly 100 after the update. See Evaluator — weights.
Returns 404 if the evaluator is not found.

Authorizations

x-api-key
string
header
required

Body

application/json

Request body for updating an evaluator. All fields except evaluator_id are optional — omit any field to leave it unchanged.

evaluator_id
string<uuid>
required

The evaluator to update.

description
string | null

New description. Max 250 characters. Omit to leave unchanged.

Maximum string length: 250
language
string

New language code for the evaluator. Omit to leave unchanged. See Evaluator — language.

context
string | null

Updated AI context prompt. Max 1000 characters. Omit to leave unchanged. See Evaluator — context.

Maximum string length: 1000
criteria
object[]

Full replacement list of criteria using merge-by-ID logic. Criteria not included will be permanently deleted. Min 1, max 10.

Response

200 - application/json

Evaluator updated successfully.

data
object