Create a routine

POST/api/companies/{companyId}/routines
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Create a routine.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

projectIdstring (uuid) | nullOptional
folderIdstring (uuid) | nullOptional
goalIdstring (uuid) | nullOptional
parentIssueIdstring (uuid) | nullOptional
titlestringRequired1–200 characters
descriptionstring | nullOptional
assigneeAgentIdstring (uuid) | nullOptional
prioritystringOptionalone of: "critical", "high", "medium", "low"
statusstringOptionalone of: "active", "paused", "archived"
concurrencyPolicystringOptionalone of: "coalesce_if_active", "always_enqueue", "skip_if_active"
catchUpPolicystringOptionalone of: "skip_missed", "enqueue_missed_with_cap"
activityGatePolicystringOptionalone of: "always", "require_external_activity"
activityGateScopestringOptionalone of: "company", "project"
variablesarray<object>Optional
variables[].namestringRequiredpattern: ^[A-Za-z][A-Za-z0-9_]*$
variables[].labelstring | nullOptionalat most 120 characters
variables[].typestringOptionalone of: "text", "textarea", "number", "boolean", "select", "date"
variables[].defaultValuestring | number | boolean | nullOptional
variables[].requiredbooleanOptional
variables[].optionsarray<string>Optionaleach at most 120 characters
envobject<string, string | object> | nullOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Routines