Справочник API публикуется на английском языке.
Create a routine
POST
/api/companies/{companyId}/routinesPersonal API keyAgent API keyConsole session
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 charactersdescriptionstring | 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 charactersvariables[].typestringНеобязательный
one of: "text", "textarea", "number", "boolean", "select", "date"variables[].defaultValuestring | number | boolean | nullНеобязательный
variables[].requiredbooleanНеобязательный
variables[].optionsarray<string>Необязательный
each at most 120 charactersenvobject<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. Подробнее: ошибки и ограничения.