La referencia de la API se publica en inglés.

Update a routine

PATCH/api/routines/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Update a routine.

Agents can update only routines assigned to them and cannot reassign them. A routine with a non-null managedByPlugin is a plugin-managed routine: that plugin created it and owns its definition (title, instructions, schedule, assignee), and the plugin can reset it to its manifest defaults. It is changed through the settings that plugin exposes, which a member opens at plugin settings, with managedByPlugin.pluginId as and this conversation's organization prefix as . Do not rewrite, detach or duplicate a plugin-managed routine to imitate a change, and do not search for another route: reply now with that link and the routine's page link.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe routine's id.

Cuerpo de la solicitud

application/json · obligatorio

projectIdstring (uuid) | nullOpcional
folderIdstring (uuid) | nullOpcional
goalIdstring (uuid) | nullOpcional
parentIssueIdstring (uuid) | nullOpcional
titlestringOpcional1–200 characters
descriptionstring | nullOpcional
assigneeAgentIdstring (uuid) | nullOpcional
prioritystringOpcionalone of: "critical", "high", "medium", "low"
statusstringOpcionalone of: "active", "paused", "archived"
concurrencyPolicystringOpcionalone of: "coalesce_if_active", "always_enqueue", "skip_if_active"
catchUpPolicystringOpcionalone of: "skip_missed", "enqueue_missed_with_cap"
activityGatePolicystringOpcionalone of: "always", "require_external_activity"
activityGateScopestringOpcionalone of: "company", "project"
variablesarray<object>Opcional
variables[].namestringObligatoriopattern: ^[A-Za-z][A-Za-z0-9_]*$
variables[].labelstring | nullOpcionalat most 120 characters
variables[].typestringOpcionalone of: "text", "textarea", "number", "boolean", "select", "date"
variables[].defaultValuestring | number | boolean | nullOpcional
variables[].requiredbooleanOpcional
variables[].optionsarray<string>Opcionaleach at most 120 characters
envobject<string, string | object> | nullOpcional
baseRevisionIdstring (uuid) | nullOpcional
responsibleUserIdstringOpcionalat least 1 character

Respuestas

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Routines