Skip to content

automation-api.mdx

Latest commit

 

History

History
370 lines (239 loc) · 67.8 KB

automation-api.mdx

File metadata and controls

370 lines (239 loc) · 67.8 KB
Raw
title Automation Api
description Automation Api protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Automation API Protocol

Defines REST CRUD endpoint schemas for managing automation flows,

triggering executions, and querying execution history.

Base path: /api/automation

@example Endpoints

GET /api/automation — List flows

GET /api/automation/:name — Get flow

POST /api/automation — Create flow

PUT /api/automation/:name — Update flow

DELETE /api/automation/:name — Delete flow

POST /api/automation/:name/trigger — Trigger flow execution

POST /api/automation/:name/toggle — Enable/disable flow

GET /api/automation/:name/runs — List execution runs

GET /api/automation/:name/runs/:runId — Get single execution run

**Source:** `packages/spec/src/api/automation-api.zod.ts`

TypeScript Usage

import { AutomationApiErrorCode, AutomationFlowPathParams, AutomationRunPathParams, CreateFlowRequest, CreateFlowResponse, DeleteFlowRequest, DeleteFlowResponse, FlowSummary, GetFlowRequest, GetFlowResponse, GetRunRequest, GetRunResponse, ListFlowsRequest, ListFlowsResponse, ListRunsRequest, ListRunsResponse, ToggleFlowRequest, ToggleFlowResponse, TriggerFlowRequest, TriggerFlowResponse, UpdateFlowRequest, UpdateFlowResponse } from '@objectstack/spec/api';
import type { AutomationApiErrorCode, AutomationFlowPathParams, AutomationRunPathParams, CreateFlowRequest, CreateFlowResponse, DeleteFlowRequest, DeleteFlowResponse, FlowSummary, GetFlowRequest, GetFlowResponse, GetRunRequest, GetRunResponse, ListFlowsRequest, ListFlowsResponse, ListRunsRequest, ListRunsResponse, ToggleFlowRequest, ToggleFlowResponse, TriggerFlowRequest, TriggerFlowResponse, UpdateFlowRequest, UpdateFlowResponse } from '@objectstack/spec/api';

// Validate data
const result = AutomationApiErrorCode.parse(data);

AutomationApiErrorCode

Allowed Values

  • flow_not_found
  • flow_already_exists
  • flow_validation_failed
  • flow_disabled
  • execution_not_found
  • execution_failed
  • execution_timeout
  • node_executor_not_found
  • concurrent_execution_limit

AutomationFlowPathParams

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)

AutomationRunPathParams

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
runId string ✅ Execution run ID

CreateFlowRequest

Properties

Property Type Required Description
name string ✅ Machine name
label string ✅ Flow label
description string optional
successMessage string optional Toast shown when a screen flow completes (defaults to a generic "Done").
errorMessage string optional Toast shown when a screen flow fails (defaults to the raw error).
version integer optional Version number
status Enum<'draft' | 'active' | 'obsolete' | 'invalid'> optional Deployment status
template boolean optional Is logic template (Subflow)
type Enum<'autolaunched' | 'record_change' | 'schedule' | 'screen' | 'api'> ✅ Flow type
variables { name: string; type: string; isInput?: boolean; isOutput?: boolean }[] optional Flow variables
nodes { id: string; type: string; label: string; config?: Record<string, any>; … }[] ✅ Flow nodes
edges { id: string; source: string; target: string; condition?: string | { dialect: Enum<'cel' | 'cron' | 'template'>; source?: string; ast?: any; meta?: object }; … }[] ✅ Flow connections
active boolean optional Is active (Deprecated: use status)
runAs Enum<'system' | 'user'> optional Execution identity for the run: system = elevated (bypasses RLS), user = the triggering user (RLS-respecting). A run with no trigger user has no identity to scope to, so under user its data operations are REFUSED — declare system to make the elevation explicit. This covers schedule/time-relative/api triggers AND any record-change flow fired by a write that carried no user.
errorHandling { strategy?: Enum<'fail' | 'retry' | 'continue'>; maxRetries?: integer; retryDelayMs?: integer; backoffMultiplier?: number; … } optional Flow-level error handling configuration
protection { lock: Enum<'none' | 'no-overlay' | 'no-delete' | 'full'>; reason: string; docsUrl?: string } optional Package author protection block — lock policy for this flow.
_lock Enum<'none' | 'no-overlay' | 'no-delete' | 'full'> optional Item-level lock — controls overlay & delete (ADR-0010).
_lockReason string optional Human-readable reason shown when a write is refused by _lock.
_lockSource Enum<'artifact' | 'package' | 'env-forced'> optional Layer that set _lock (artifact | package | env-forced).
_provenance Enum<'package' | 'org' | 'env-forced'> optional Origin of the item (package | org | env-forced).
_packageId string optional Owning package machine id.
_packageVersion string optional Owning package version.
_lockDocsUrl string optional Optional documentation link surfaced next to _lockReason.

CreateFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { name: string; label: string; description?: string; successMessage?: string; … } ✅ The created flow definition

DeleteFlowRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)

DeleteFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { name: string; deleted: boolean } ✅

FlowSummary

Properties

Property Type Required Description
name string ✅ Flow machine name
label string ✅ Flow display label
type string ✅ Flow type
status string ✅ Flow deployment status
version integer ✅ Flow version number
enabled boolean ✅ Whether the flow is enabled for execution
nodeCount integer optional Number of nodes in the flow
lastRunAt string optional Last execution timestamp

GetFlowRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)

GetFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { name: string; label: string; description?: string; successMessage?: string; … } ✅ Full flow definition

GetRunRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
runId string ✅ Execution run ID

GetRunResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { id: string; flowName: string; flowVersion?: integer; status: Enum<'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'timed_out' | 'retrying'>; … } ✅ Full execution log with step details

ListFlowsRequest

Properties

Property Type Required Description
status Enum<'draft' | 'active' | 'obsolete' | 'invalid'> optional Filter by flow status
type Enum<'autolaunched' | 'record_change' | 'schedule' | 'screen' | 'api'> optional Filter by flow type
limit integer ✅ Maximum number of flows to return
cursor string optional Cursor for pagination

ListFlowsResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { flows: { name: string; label: string; type: string; status: string; … }[]; total?: integer; nextCursor?: string; hasMore: boolean } ✅

ListRunsRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
status Enum<'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'timed_out' | 'retrying'> optional Filter by execution status
limit integer ✅ Maximum number of runs to return
cursor string optional Cursor for pagination

ListRunsResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { runs: { id: string; flowName: string; flowVersion?: integer; status: Enum<'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'timed_out' | 'retrying'>; … }[]; total?: integer; nextCursor?: string; hasMore: boolean } ✅

ToggleFlowRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
enabled boolean ✅ Whether to enable (true) or disable (false) the flow

ToggleFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { name: string; enabled: boolean } ✅

TriggerFlowRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
record Record<string, any> optional Record that triggered the automation
object string optional Object name the record belongs to
event string optional Trigger event type
userId string optional User who triggered the automation
params Record<string, any> optional Additional contextual data

TriggerFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { success: boolean; output?: any; error?: string; durationMs?: number } ✅

UpdateFlowRequest

Properties

Property Type Required Description
name string ✅ Flow machine name (snake_case)
definition { name?: string; label?: string; description?: string; successMessage?: string; … } ✅ Partial flow definition to update

UpdateFlowResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: Enum<'VALIDATION_ERROR' | 'INVALID_FIELD' | 'MISSING_REQUIRED_FIELD' | 'INVALID_FORMAT' | 'VALUE_TOO_LONG' | 'VALUE_TOO_SHORT' | 'VALUE_OUT_OF_RANGE' | 'INVALID_REFERENCE' | 'DUPLICATE_VALUE' | 'INVALID_QUERY' | 'INVALID_FILTER' | 'INVALID_SORT' | 'MAX_RECORDS_EXCEEDED' | 'UNAUTHENTICATED' | 'INVALID_CREDENTIALS' | 'EXPIRED_TOKEN' | 'INVALID_TOKEN' | 'SESSION_EXPIRED' | 'MFA_REQUIRED' | 'EMAIL_NOT_VERIFIED' | 'PERMISSION_DENIED' | 'INSUFFICIENT_PRIVILEGES' | 'FIELD_NOT_ACCESSIBLE' | 'RECORD_NOT_ACCESSIBLE' | 'LICENSE_REQUIRED' | 'IP_RESTRICTED' | 'TIME_RESTRICTED' | 'RESOURCE_NOT_FOUND' | 'OBJECT_NOT_FOUND' | 'RECORD_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'RESOURCE_CONFLICT' | 'CONCURRENT_MODIFICATION' | 'DELETE_RESTRICTED' | 'DUPLICATE_RECORD' | 'LOCK_CONFLICT' | 'METHOD_NOT_ALLOWED' | 'PRECONDITION_REQUIRED' | 'RATE_LIMIT_EXCEEDED' | 'QUOTA_EXCEEDED' | 'CONCURRENT_LIMIT_EXCEEDED' | 'INTERNAL_ERROR' | 'DATABASE_ERROR' | 'TIMEOUT' | 'SERVICE_UNAVAILABLE' | 'NOT_IMPLEMENTED' | 'EXTERNAL_SERVICE_ERROR' | 'INTEGRATION_ERROR' | 'WEBHOOK_DELIVERY_FAILED' | 'BATCH_PARTIAL_FAILURE' | 'BATCH_COMPLETE_FAILURE' | 'TRANSACTION_FAILED' | 'ACCOUNT_LOCKED' | 'ALREADY_REVERTED' | 'AMBIGUOUS_MATCH' | 'ANALYTICS_QUERY_FAILED' | 'APPROVAL_ACTIONS_FAILED' | 'APPROVAL_RECALL_FAILED' | 'APPROVAL_REQUEST_GET_FAILED' | 'APPROVAL_REQUEST_LIST_FAILED' | 'ASYNC_NOT_SUPPORTED' | 'ATTACHMENT_DELETE_DENIED' | 'ATTACHMENT_DOWNLOAD_DENIED' | 'ATTACHMENT_PARENT_ACCESS' | 'AUDIENCE_NOT_ALLOWED' | 'AUTH_CONFIG_ERROR' | 'AUTH_REQUIRED' | 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' | 'BATCH_ABORTED' | 'BATCH_NOT_ATOMIC' | 'BATCH_TOO_LARGE' | 'BATCH_UNRESOLVED_REF' | 'BLANK_MATCH_KEY' | 'CLONE_DISABLED' | 'CLOUD_FETCH_FAILED' | 'CLOUD_UNCONFIGURED' | 'COMMIT_NOT_FOUND' | 'CONCURRENT_UPDATE' | 'CONFLICTING_MAPPING' | 'CONNECTOR_UPSTREAM_UNAVAILABLE' | 'CREATE_FAILED' | 'CUBE_NOT_FOUND' | 'DATASET_INVALID' | 'DATASOURCE_ADMIN_ERROR' | 'DELEGABLE_SCOPE_FAILED' | 'DELIVERY_NOT_ELIGIBLE' | 'DESTRUCTIVE_CHANGE' | 'DEVICE_CODE_FAILED' | 'DOMAIN_VERIFICATION_DISABLED' | 'DOMAIN_VERIFICATION_FAILED' | 'DRIVER_UNAVAILABLE' | 'DUPLICATE_REQUEST' | 'EMAIL_SEND_FAILED' | 'EMAIL_SERVICE_REQUIRED' | 'ENQUEUE_FAILED' | 'ENVIRONMENT_BIND_FAILED' | 'ENVIRONMENT_NOT_FOUND' | 'ENV_ACCESS_DENIED' | 'ERR_BULK_RESULT_MISMATCH' | 'ERR_DATASOURCE_UNAVAILABLE' | 'ERR_DRIVER_CONNECT' | 'ERR_FILE_CONSTRAINT' | 'ERR_FILE_REFERENCE_COPY' | 'ERR_SUMMARY_RECOMPUTE' | 'EXECUTION_ERROR' | 'EXPIRED_OR_REVOKED' | 'EXPIRY_IN_PAST' | 'EXPIRY_TOO_LONG' | 'EXPLAIN_FAILED' | 'EXPORT_NOT_PERMITTED' | 'EXTERNAL_IMPORT_ERROR' | 'EXTERNAL_SCHEMA_MISMATCH' | 'EXTERNAL_SCHEMA_MODE_VIOLATION' | 'EXTERNAL_WRITE_FORBIDDEN' | 'FEEDS_DISABLED' | 'FILES_DISABLED' | 'FILE_DOWNLOAD_DENIED' | 'FILE_NOT_FOUND' | 'FILTER_TOKEN_UNKNOWN' | 'FILTER_TOKEN_UNRESOLVED' | 'FORBIDDEN' | 'FORM_NOT_FOUND' | 'FORM_RESOLVE_FAILED' | 'IMPORT_JOB_CREATE_FAILED' | 'IMPORT_ROW_FAILED' | 'INTERNAL' | 'INVALID_EMAIL' | 'INVALID_EXPIRY' | 'INVALID_METADATA' | 'INVALID_OR_EXPIRED' | 'INVALID_PHONE' | 'INVALID_REQUEST' | 'INVALID_RESUME_TOKEN' | 'INVALID_SIGNAL' | 'INVALID_SIGNATURE' | 'INVALID_STATE' | 'INVITE_EMAIL_FAILED' | 'INVITE_REQUIRES_EMAIL' | 'INVITE_SMS_FAILED' | 'IP_NOT_ALLOWED' | 'ITEM_LOCKED' | 'LAST_LOCAL_CREDENTIAL' | 'LOOKUP_NOT_PUBLIC' | 'LOOKUP_TARGET_MISSING' | 'MANIFEST_CONFLICT' | 'MAPPING_FORMAT_MISMATCH' | 'MAPPING_FORMAT_UNSUPPORTED' | 'MAPPING_NOT_FOUND' | 'MAPPING_TARGET_MISMATCH' | 'MARKETPLACE_PROXY_FAILED' | 'MARKETPLACE_STORAGE_FAILED' | 'MARKETPLACE_UNAVAILABLE' | 'METADATA_BRANCH' | 'METADATA_CONFLICT' | 'METADATA_NOT_FOUND' | 'METADATA_SCHEMA_INVALID' | 'MONGODB_MULTI_TENANT_UNSUPPORTED' | 'NAMESPACE_PREFIX' | 'NEEDS_PASSWORD' | 'NODE_FAILURE' | 'NOTHING_TO_PURGE' | 'NOT_CREATABLE' | 'NOT_FOUND' | 'NOT_OVERRIDABLE' | 'NOT_UNDOABLE' | 'NO_DRAFT' | 'NO_EXECUTOR' | 'NO_IDENTITY' | 'NO_MATCH' | 'NO_PENDING_VERIFICATION' | 'OAUTH_REGISTER_FAILED' | 'OBJECT_API_DISABLED' | 'OBJECT_API_METHOD_NOT_ALLOWED' | 'OPENAPI_UNAVAILABLE' | 'OS_PROTOCOL_INCOMPATIBLE' | 'OVERLAY_PERSISTENCE_FAILED' | 'PACKAGE_DELETE_FAILED' | 'PACKAGE_DELETE_PARTIAL' | 'PACKAGE_MANIFEST_INVALID' | 'PACKAGE_PUBLISH_FAILED' | 'PASSWORD_ALREADY_SET' | 'PASSWORD_EXPIRED' | 'PASSWORD_POLICY_VIOLATION' | 'PASSWORD_REUSE' | 'PAYLOAD_TOO_LARGE' | 'PERMISSION_NOT_ALLOWED' | 'PHONE_NOT_ENABLED' | 'PLUGIN_INSTALL_FAILED' | 'PLUGIN_MANIFEST_INVALID' | 'PLUGIN_REGISTER_FAILED' | 'PROJECT_MEMBERSHIP_REQUIRED' | 'PROJECT_NOT_FOUND' | 'PROJECT_PROVISIONING' | 'PROJECT_PROVISIONING_FAILED' | 'RAW_SQL_UNSUPPORTED' | 'RECORD_GONE' | 'RECORD_LOCKED' | 'REPORTS_LIST_FAILED' | 'REPORT_DELETE_FAILED' | 'REPORT_GET_FAILED' | 'REPORT_NOT_FOUND' | 'REPORT_RUN_FAILED' | 'REPORT_SAVE_FAILED' | 'REPORT_SCHEDULE_FAILED' | 'REQUEST_NOT_FOUND' | 'RESEED_NO_ROWS' | 'RESEED_SKIPPED' | 'ROUTE_NOT_FOUND' | 'RULE_DEFINE_FAILED' | 'RULE_DELETE_FAILED' | 'RULE_EVALUATE_FAILED' | 'RULE_GET_FAILED' | 'RULE_LIST_FAILED' | 'RULE_NOT_FOUND' | 'SAML_REGISTER_FAILED' | 'SCHEDULES_LIST_FAILED' | 'SCHEDULE_DELETE_FAILED' | 'SETTINGS_ACTION_FAILED' | 'SETTINGS_FORBIDDEN' | 'SETTINGS_LOCKED' | 'SETTINGS_UNKNOWN_KEY' | 'SETTINGS_UNKNOWN_NAMESPACE' | 'SETTINGS_VALIDATION' | 'SHARES_LIST_FAILED' | 'SHARE_GRANT_FAILED' | 'SHARE_REVOKE_FAILED' | 'SHARING_NOT_ENABLED' | 'SIGN_IN_REQUIRED' | 'SSO_REGISTER_FAILED' | 'SSO_REGISTER_FORBIDDEN' | 'SUGGESTION_CONFIRM_FAILED' | 'SUGGESTION_DISMISS_FAILED' | 'SUGGESTION_LIST_FAILED' | 'SUGGESTION_NOT_FOUND' | 'SUGGESTION_STATE' | 'SUMMARY_RECOMPUTE_FAILED' | 'UNAUTHORIZED' | 'UNIQUE_VIOLATION' | 'UNKNOWN_KEY' | 'UNKNOWN_NAMESPACE' | 'UNSUPPORTED' | 'UNSUPPORTED_QUERY_PARAM' | 'UNSUPPORTED_TRANSFORM' | 'UPLOAD_SESSION_NOT_FOUND' | 'USER_ALREADY_EXISTS' | 'VALIDATION_FAILED' | 'VERSION_NOT_FOUND' | 'VERSION_NOT_RESTORABLE' | 'WRITABLE_PACKAGE_REQUIRED' | 'WRONG_PASSWORD'>; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { name: string; label: string; description?: string; successMessage?: string; … } ✅ The updated flow definition