Справочник API публикуется на английском языке.

Update a routine

PATCH/api/routines/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

idstringОбязательныйThe routine's id.

Тело запроса

application/json · обязательно

projectIdstring (uuid) | nullНеобязательный
folderIdstring (uuid) | nullНеобязательный
goalIdstring (uuid) | nullНеобязательный
parentIssueIdstring (uuid) | nullНеобязательный
titlestringНеобязательный1–200 characters
descriptionstring | nullНеобязательный
assigneeAgentIdstring (uuid) | nullНеобязательный
prioritystringНеобязательныйone of: "critical", "high", "medium", "low"
statusstringНеобязательныйone of: "active", "paused", "archived"
concurrencyPolicystringНеобязательныйone of: "coalesce_if_active", "always_enqueue", "skip_if_active"
catchUpPolicystringНеобязательныйone of: "skip_missed", "enqueue_missed_with_cap"
activityGatePolicystringНеобязательныйone of: "always", "require_external_activity"
activityGateScopestringНеобязательныйone of: "company", "project"
variablesarray<object>Необязательный
variables[].namestringОбязательныйpattern: ^[A-Za-z][A-Za-z0-9_]*$
variables[].labelstring | nullНеобязательныйat most 120 characters
variables[].typestringНеобязательныйone of: "text", "textarea", "number", "boolean", "select", "date"
variables[].defaultValuestring | number | boolean | nullНеобязательный
variables[].requiredbooleanНеобязательный
variables[].optionsarray<string>Необязательныйeach at most 120 characters
envobject<string, string | object> | nullНеобязательный
baseRevisionIdstring (uuid) | nullНеобязательный
responsibleUserIdstringНеобязательныйat least 1 character

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Routines