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

Create a routine

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

Create a routine.

Авторизация

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

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

companyIdstringОбязательныйThe organization'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Необязательный

Ответы

201SuccessCreated; the body holds the new resource.
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