La référence de l'API est publiée en anglais.

Update a routine

PATCH/api/routines/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe routine's id.

Corps de la requête

application/json · obligatoire

projectIdstring (uuid) | nullFacultatif
folderIdstring (uuid) | nullFacultatif
goalIdstring (uuid) | nullFacultatif
parentIssueIdstring (uuid) | nullFacultatif
titlestringFacultatif1–200 characters
descriptionstring | nullFacultatif
assigneeAgentIdstring (uuid) | nullFacultatif
prioritystringFacultatifone of: "critical", "high", "medium", "low"
statusstringFacultatifone of: "active", "paused", "archived"
concurrencyPolicystringFacultatifone of: "coalesce_if_active", "always_enqueue", "skip_if_active"
catchUpPolicystringFacultatifone of: "skip_missed", "enqueue_missed_with_cap"
activityGatePolicystringFacultatifone of: "always", "require_external_activity"
activityGateScopestringFacultatifone of: "company", "project"
variablesarray<object>Facultatif
variables[].namestringObligatoirepattern: ^[A-Za-z][A-Za-z0-9_]*$
variables[].labelstring | nullFacultatifat most 120 characters
variables[].typestringFacultatifone of: "text", "textarea", "number", "boolean", "select", "date"
variables[].defaultValuestring | number | boolean | nullFacultatif
variables[].requiredbooleanFacultatif
variables[].optionsarray<string>Facultatifeach at most 120 characters
envobject<string, string | object> | nullFacultatif
baseRevisionIdstring (uuid) | nullFacultatif
responsibleUserIdstringFacultatifat least 1 character

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Routines