Act as a trigger that start an automation. There are 4 different types
onTaskCreated: Automation will happen when a task is created.
onTaskFinished: Automation will happen when a task is finished (status task: Done).
onTaskAssigned: Automation will happen when a task is assigned to field user(s).
onDataSourceCreated: Automation will happen when a datasource is created.
Automation's type. The changes you want to automate. There are 6 different types:
createTask: The task will create when an event happens.
createAssignTask: will create assigned task when an event happens.
moveTask: The task will move to the selected hub when an event happens.
assignTask: The task will automatically assigned to the selected user on a hub when an event happens.
webhook: The data task or data source will sent to the specific URL when an event happens.
createOrUpdateDataSource: The data source will create or update when an event happens.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Docs","colors":{"primary":"#02A8F3","light":"#02A8F3","dark":"#028FCF"},"favicon":"https://mintcdn.com/mile-app/JbFasViqaZTzE9Zc/favicon.ico?fit=max\u0026auto=format\u0026n=JbFasViqaZTzE9Zc\u0026q=85\u0026s=4e7ddbcee052a480a983e57b5e25103b","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"}}},"search":{},"seo":{"metatags":{"robots":"noindex, nofollow"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mile-app","hasAudioNarration":false,"actualSubdomain":"mile-app","customDomains":["docsy3.mile.app"],"gitSource":{"type":"gitlab","owner":"paketid","repo":"mileapp-docs","deployBranch":"whitelabel","contentDirectory":"","isPrivate":true,"projectId":76553900,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6abdd0a3503afc6fc766f9c9","collectionId":"7da1e5b0-9dcc-4967-b311-365ce82d22c4","liveDeploymentHistoryId":"6abdd0a3503afc6fc766f9c9","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6abdd0a3503afc6fc766f9c9","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guides","count":209},{"language":"default","tag":"API Reference","count":199},{"language":"default","tag":"Task","count":99},{"language":"default","tag":"Flow","count":76},{"language":"default","tag":"Setting","count":60},{"language":"default","tag":"Automation","count":39},{"language":"default","tag":"Flow Builder","count":33},{"language":"default","tag":"Route Optimization","count":32},{"language":"default","tag":"Routing","count":28},{"language":"default","tag":"Overview","count":25}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"a[href=\"/\"]>img,header>a:first-child img,img[src*=\"/logo/\"],nav>a:first-child img{width:150px!important;height:auto!important;max-width:150px!important}"}],"page":{"pagePath":"api-reference/objects/automation-object","slug":"/api-reference/objects/automation-object","pageMetadata":{"title":"Automation object","openapi-schema":"openapi/public/openapi-full.json Automation","description":null,"href":"/api-reference/objects/automation-object"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Automation object","openapi-schema":"openapi/public/openapi-full.json Automation","description":null,"href":"/api-reference/objects/automation-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mile-app/1d49f46686dcd76c/scripts/build-openapi.js","/_mintlify/custom/mile-app/bbd4ec23fcfb0c2b/scripts/check-schema.js","/_mintlify/custom/mile-app/620df530e90e7f77/scripts/generate-tag-overviews.js"],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the automation that generated by system.","uniqueKey":"_id","typeLabel":"string"},"name":{"type":"string","description":"The name of automation.","uniqueKey":"name","typeLabel":"string"},"event":{"type":"string","description":"Act as a trigger that start an automation. There are 4 different types \n **onTaskCreated**: Automation will happen when a task is created. \n **onTaskFinished**: Automation will happen when a task is finished (status task: Done). \n **onTaskAssigned**: Automation will happen when a task is assigned to field user(s). \n **onDataSourceCreated**: Automation will happen when a datasource is created.","uniqueKey":"event","typeLabel":"string"},"automationType":{"type":"string","description":"Automation's type. The changes you want to automate. There are 6 different types: \n **createTask**: The task will create when an event happens. \n **createAssignTask**: will create assigned task when an event happens. \n **moveTask**: The task will move to the selected hub when an event happens. \n **assignTask**: The task will automatically assigned to the selected user on a hub when an event happens. \n **webhook**: The data task or data source will sent to the specific URL when an event happens.\n **createOrUpdateDataSource**: The data source will create or update when an event happens.","uniqueKey":"automationType","typeLabel":"string"},"dataType":{"type":"string","description":"Automation's data type to describe that automation is running on a **task** or **data** module.","uniqueKey":"dataType","typeLabel":"string"},"automationDetails":{"type":"object","description":"Set of fields according to the selected automation type.","properties":{"flow":{"description":"FlowName to select specific task format to be created on automation event. When creating or updating a automation, you cannot use the flow with the name `Handover` because it has been used as a reserved key. Field only exist, if *automationType* is **createTask** and **createAssignTask**","type":"string","uniqueKey":"automationDetails.flow","typeLabel":"string"},"flowId":{"description":"Identifier of Flow to select specific task for event to happens. When creating or updating a automation. `flowId` is required for dataType is task and all automationType value.","type":"string","uniqueKey":"automationDetails.flowId","typeLabel":"string"},"taskData":{"description":"The task will be created with the given data (different flow may have different sets of field). Field only exist, if *automationType* is **createTask** and **createAssignTask** \nThe value can be set as static value such as: `'Jakarta'`.\nor set as dynamic value according to `rules.flow` such as : `'$refFlow.name'`","type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"automationDetails.taskData.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automationDetails.taskData","typeLabel":"object[]"},"hubId":{"description":"Hub identifier to define task location when an event happens. Field only exist, if *automationType* is **moveTask** and **createAssignTask**. To use a dynamic hub, you can utilize the hubId with the value `$refFlow.hubId` in the **createAssignTask** type. ","type":"string","uniqueKey":"automationDetails.hubId","typeLabel":"string"},"assignee":{"description":"List of email that has been assigned the task. Worker's email that assigned to the task. One task can be assigned by multiple worker. Field only exist, if *automationType* is **assignTask** and **createAssignTask** ","type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"automationDetails.assignee.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automationDetails.assignee","typeLabel":"object[]"},"reassignment":{"description":"Type of reassigment that will be auto assign when user created task. Field only exist, if *event* is **onTaskFinished** or **onTaskCreated** and *automationType* is **createAssignTask**. \n There are 3 types of *reassigment* if *event* is **onTaskFinished** :`assignee`,`assignedBy`,`doneBy`. \n and there are 2 type of *reassigment* if *event* is **onTaskCreated** :`assignee`,`assignedBy`.","type":"string","uniqueKey":"automationDetails.reassignment","typeLabel":"string"},"url":{"description":"The address that payloads are sent to. Field only exist, if *automationType* is **webhook**","type":"string","uniqueKey":"automationDetails.url","typeLabel":"string"},"headers":{"description":"Used to to provide additional information when default headers are not enough then they can use a custom header configuration. Field only exist, if *automationType* is **webhook**","type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"automationDetails.headers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automationDetails.headers","typeLabel":"object[]"},"dataTypeId":{"description":"Data Type Id to select specific data source format to be executed on automation event. Field only exist, if *automationType* is **createOrUpdateDataSource**","type":"string","uniqueKey":"automationDetails.dataTypeId","typeLabel":"string"},"dataTypeName":{"description":"Data Type Name is not required. our system will set the value according to dataTypeId.","type":"string","uniqueKey":"automationDetails.dataTypeName","typeLabel":"string"},"dataId":{"description":"Data Id to select specific flow's component id format to be executed on automation event. Field only exist, if *automationType* is **createOrUpdateDataSource**. Value can be set as dynamic values according to the data source that has been mapped with the flow such as : `$refFlow.pickupNumber`","type":"string","uniqueKey":"automationDetails.dataId","typeLabel":"string"},"dataSource":{"description":"The data source will be created or updated with the given data (different data type id may have different sets of field). Field only exist, if *automationType* is **createOrUpdateDataSource**. The value can be set as static value such as: `'Jakarta'`.\nor set as dynamic value according to `rules.flow` such as : `'$refFlow.phoneNumber'`","type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"automationDetails.dataSource.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automationDetails.dataSource","typeLabel":"object[]"},"updateLimitUser":{"type":"boolean","description":"Configuration to run automation using user limit. If `updateLimitUser` has a value of true, users can execute automation using either 'limitUser' or 'limitType'. And if `updateLimitUser` has a value of false, the automation will run without using a user limit.Field only exist, if *automationType* is **createOrUpdateDataSource**.","uniqueKey":"automationDetails.updateLimitUser","typeLabel":"boolean"},"replaceLimitUser":{"type":"boolean","description":"Configuration to replace the current user limit. If `replaceLimitUser` is set to `true`, the automation will replace the existing user limit using either `limitUser` or `limitType`. If `replaceLimitUser` is set to `false`, the automation will run without modifying the existing user limit. This field only exists if *automationType* is **createOrUpdateDataSource**. Note: `updateLimitUser` and `replaceLimitUser` cannot both be set to `true` at the same time.","uniqueKey":"automationDetails.replaceLimitUser","typeLabel":"boolean"},"limitUser":{"type":"array","description":"Data source automation will be created using user restrictions based on user emails in the same organization or can be empty if the data source can be accessed by all users. Field only exist, if *automationType* is **createOrUpdateDataSource** and *updateLimitUser* or *replaceLimitUser* is **true**.","items":{"type":"string","uniqueKey":"automationDetails.limitUser.items.[INDEX]","typeLabel":"string"},"uniqueKey":"automationDetails.limitUser","typeLabel":"string[]"},"limitType":{"type":"string","description":"Data source automation will be created using user restrictions determined based **assignee**, **assignedBy** and **doneBy** when completing a task. Field only exist, if *automationType* is **createOrUpdateDataSource** and *updateLimitUser* or *replaceLimitUser* is **true**.","uniqueKey":"automationDetails.limitType","typeLabel":"string"}},"uniqueKey":"automationDetails","typeLabel":"object"},"rules":{"type":"object","description":"Act as an automation's criteria. Criteria that must be true to run an Automation. ","properties":{"flow":{"description":"FlowName to select specific task for event to happens. When creating or updating a automation, you cannot use the flow with the name `Handover` because it has been used as a reserved key. `flow` is required for dataType is task and all automationType value.","type":"string","uniqueKey":"rules.flow","typeLabel":"string"},"flowId":{"description":"Identifier of Flow to select specific task for event to happens. When creating or updating a automation. `flowId` is required for dataType is task and all automationType value.","type":"string","uniqueKey":"rules.flowId","typeLabel":"string"},"dataTypeId":{"description":"DataTypeId to select specific data source for event to happens. `dataTypeId` is required for dataType is data and automationType is createTask or webhook","type":"string","uniqueKey":"rules.dataTypeId","typeLabel":"string"},"fields":{"description":"**Example for dataType 'task'** \n Additional automation's filter. \nUse [GET /flow-fields API](#tag/Flow/operation/flowFields) to get the list of structure data.\n`fields` is required for **all automationType value except `webhook`**.\n**Example:** \n`{`\n`'name'`:`'roger'`,\n`'address'`:`'kemayoran'`\n`}` \n\n **Example for dataType 'data'** \n Use [GET /data-types API](#tag/Data-Type/operation/getDataType) to get the list of structure data.\n`fields` is required for **automationType is `createTask`**.\n**Example:** \n`{`\n`'name'`:`'roger'`,\n`'address'`:`'kemayoran'`\n`}`","type":"object","additionalProperties":true,"uniqueKey":"rules.fields","typeLabel":"object"},"schema":{"description":"A combination of `rules.flow` and `rules.fields` generated by the system.","type":"string","uniqueKey":"rules.schema","typeLabel":"string"}},"uniqueKey":"rules","typeLabel":"object"},"organizationId":{"type":"string","description":"The identifier for the organization that generated by system.","uniqueKey":"organizationId","typeLabel":"string"},"isActive":{"type":"boolean","description":"Automation's active state, only active automation will proceed by system","uniqueKey":"isActive","typeLabel":"boolean"},"createdTime":{"type":"string","format":"date-time","description":"Time at which the automation was created.","uniqueKey":"createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"Time at which the automation was updated.","uniqueKey":"updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"Email that created the automation.","uniqueKey":"createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"Email that updated the automation.","uniqueKey":"updatedBy","typeLabel":"string"}},"example":{"title":"Example","value":{"_id":"654c79dd6c763c3d337ce792","name":"automation create task","event":"onTaskCreated","automationType":"assignTask","dataType":"task","automationDetails":{"assignee":["[email protected]"],"hubId":"64180853e480b10a631c8452"},"rules":{"fields":{"customerName":"automation"},"flow":"Delivery","schema":"flow:customerName"},"organizationId":"641807adbfaea73910208b09","isActive":true,"createdBy":"[email protected]","updatedBy":"[email protected]","updatedTime":"2023-11-09T10:56:56+00:00","createdTime":"2023-11-09T10:56:56+00:00"}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"openapi/public/openapi-full.json"},"subdomain":"mile-app","siteName":"Docs","title":"Automation object - Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T03:19:04.029Z","originalFileLocation":"api-reference/objects/automation-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Automation object - Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docsy3.mile.app/api-reference/objects/automation-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mile-app.mintlify.app/_mintlify/api/og/v2?division=Objects\u0026amp;title=Automation+object\u0026amp;theme=d8f06ae19fc507e5db12c83f\u0026amp;signature=45f13b978620517ebdd55129986bb68e4774e6f26c4cd02b0e83c0cfc07c5d77\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Automation object - Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mile-app.mintlify.app/_mintlify/api/og/v2?division=Objects\u0026amp;title=Automation+object\u0026amp;theme=d8f06ae19fc507e5db12c83f\u0026amp;signature=45f13b978620517ebdd55129986bb68e4774e6f26c4cd02b0e83c0cfc07c5d77\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#02A8F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docsy3.mile.app/api-reference/objects/automation-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/objects/automation-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docsy3.mile.app/#organization\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://docsy3.mile.app#website\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docsy3.mile.app/api-reference/objects/automation-object#webpage\",\"url\":\"https://docsy3.mile.app/api-reference/objects/automation-object\",\"name\":\"Automation object\",\"dateModified\":\"2026-10-01T03:19:04.029Z\",\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"},\"breadcrumb\":{\"@id\":\"https://docsy3.mile.app/api-reference/objects/automation-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docsy3.mile.app/api-reference/objects/automation-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Objects\",\"item\":\"https://docsy3.mile.app/api-reference/objects/task-object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Automation object\",\"item\":\"https://docsy3.mile.app/api-reference/objects/automation-object\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docsy3.mile.app/api-reference/objects/automation-object#apireference\",\"headline\":\"Automation object\",\"name\":\"Automation object\",\"url\":\"https://docsy3.mile.app/api-reference/objects/automation-object\",\"mainEntityOfPage\":{\"@id\":\"https://docsy3.mile.app/api-reference/objects/automation-object#webpage\"},\"dateModified\":\"2026-10-01T03:19:04.029Z\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Data Formats","href":"/api-reference/data-formats"},{"title":"Status Codes","href":"/api-reference/status-codes"}]},{"group":"Tools","pages":[{"group":"Short Token","pages":[{"title":"Generate Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/generate","href":"/api-reference/tools/short-token/generate-short-token"},{"title":"Resolve Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/resolve","href":"/api-reference/tools/short-token/resolve-short-token"}]}]},{"group":"Webhook","pages":[{"title":"How does it works","href":"/api-reference/webhooks/how-it-works"},{"title":"Delivery Attempts and Retries","href":"/api-reference/webhooks/delivery-attempts"},{"title":"Quick Response Requirement","href":"/api-reference/webhooks/quick-response"},{"title":"Failure Monitoring and Notification Process","href":"/api-reference/webhooks/failure-monitoring"},{"group":"Webhook","pages":[{"title":"Task events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook task-events","href":"/api-reference/webhooks/webhook/task-events"},{"title":"On data source created","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook data-source-created","href":"/api-reference/webhooks/webhook/on-data-source-created"},{"title":"Routing events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook routing-events","href":"/api-reference/webhooks/webhook/routing-events"},{"title":"Trip events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook trip-events","href":"/api-reference/webhooks/webhook/trip-events"}]}]},{"group":"Task","pages":[{"group":"Overview","pages":[{"title":"Task","href":"/api-reference/task/overview"},{"title":"Location History","href":"/api-reference/task/location-history-overview"},{"title":"Task Schedule","href":"/api-reference/task/task-schedule-overview"},{"title":"Overview","href":"/api-reference/activity/overview"}]},{"group":"Task","pages":[{"title":"Read tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks","href":"/api-reference/task/task/read-tasks"},{"title":"Read tasks gallery","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks-gallery","href":"/api-reference/task/task/read-tasks-gallery"},{"title":"Read task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/{task_id}","href":"/api-reference/task/task/read-task-by-id"},{"title":"Read public task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/public/{task_id}","href":"/api-reference/task/task/read-public-task-by-id"},{"title":"Read task tracking","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks/tracking","href":"/api-reference/task/task/read-task-tracking"},{"title":"Create task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task","href":"/api-reference/task/task/create-task"},{"title":"Create multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /tasks/bulk/","href":"/api-reference/task/task/create-multiple-tasks"},{"title":"Upload image for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{forRenameFile}","href":"/api-reference/task/task/upload-image-for-task"},{"title":"Upload video for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{forRenameFile}","href":"/api-reference/task/task/upload-video-for-task"},{"title":"Update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskid}","href":"/api-reference/task/task/update-task-by-id"},{"title":"Update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/#","href":"/api-reference/task/task/update-multiple-tasks"},{"title":"Move task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/move","href":"/api-reference/task/task/move-task-by-id"},{"title":"Assign task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/assign","href":"/api-reference/task/task/assign-task-by-id"},{"title":"Move multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/move","href":"/api-reference/task/task/move-multiple-tasks"},{"title":"Assign multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/assign","href":"/api-reference/task/task/assign-multiple-tasks"},{"title":"Partially update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/{taskId}","href":"/api-reference/task/task/partially-update-task-by-id"},{"title":"Delete multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /tasks/bulk","href":"/api-reference/task/task/delete-multiple-tasks"},{"title":"Partial update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /tasks/bulk","href":"/api-reference/task/task/partial-update-multiple-tasks"},{"title":"Delete task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/{id}","href":"/api-reference/task/task/delete-task-by-id"}]},{"group":"Location History","pages":[{"title":"Read location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-histories","href":"/api-reference/task/location-history/read-location-history"},{"title":"Read location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/{id}","href":"/api-reference/task/location-history/read-location-history-by-id"},{"title":"Read location history by token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/tracking/{token}","href":"/api-reference/task/location-history/read-location-history-by-token"},{"title":"Create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history","href":"/api-reference/task/location-history/create-location-history"},{"title":"Bulk create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/bulk","href":"/api-reference/task/location-history/bulk-create-location-history"},{"title":"Generate location history token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/generate-token","href":"/api-reference/task/location-history/generate-location-history-token"},{"title":"Update location history by email \u0026 createdTime","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/","href":"/api-reference/task/location-history/update-location-history-by-email-\u0026-createdtime"},{"title":"Update location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-location-history-by-id"},{"title":"Delete location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /location-history/{loc_history_id}","href":"/api-reference/task/location-history/delete-location-history-by-id"},{"title":"Update partially location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-partially-location-history-by-id"}]},{"group":"Task Schedule","pages":[{"title":"Read task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedules","href":"/api-reference/task/task-schedule/read-task-schedule"},{"title":"Read task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedule/{id}","href":"/api-reference/task/task-schedule/read-task-schedule-by-id"},{"title":"Create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedule","href":"/api-reference/task/task-schedule/create-task-schedule"},{"title":"Bulk create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedules/bulk","href":"/api-reference/task/task-schedule/bulk-create-task-schedule"},{"title":"Update task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-task-schedule-by-id"},{"title":"Delete task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/delete-task-schedule-by-id"},{"title":"Update partially task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-partially-task-schedule-by-id"}]}]},{"group":"Routing","pages":[{"group":"Overview","pages":[{"title":"Routing","href":"/api-reference/routing/overview"},{"title":"Vehicle","href":"/api-reference/routing/vehicle-overview"}]},{"group":"Vehicle","pages":[{"title":"Read vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicles","href":"/api-reference/routing/vehicle/read-vehicle"},{"title":"Read vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/read-vehicle-by-id"},{"title":"Update vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-vehicle-by-id"},{"title":"Delete vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/delete-vehicle-by-id"},{"title":"Update partially vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-partially-vehicle-by-id"},{"title":"Create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicle","href":"/api-reference/routing/vehicle/create-vehicle"},{"title":"Bulk create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicles/","href":"/api-reference/routing/vehicle/bulk-create-vehicle"},{"title":"Delete vehicle by Hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicles/{hubId}/hub","href":"/api-reference/routing/vehicle/delete-vehicle-by-hub"}]},{"group":"Routing","pages":[{"title":"Read routing results","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /results","href":"/api-reference/routing/routing/read-routing-results"},{"title":"Read routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}","href":"/api-reference/routing/routing/read-routing-result-by-id"},{"title":"Update routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}","href":"/api-reference/routing/routing/update-routing-result-by-id"},{"title":"Delete routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /result/{resultId}","href":"/api-reference/routing/routing/delete-routing-result-by-id"},{"title":"Update partially routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /result/{resultId}","href":"/api-reference/routing/routing/update-partially-routing-result-by-id"},{"title":"Route optimize","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing","href":"/api-reference/routing/routing/route-optimize"},{"title":"Dispatch routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /dispatch","href":"/api-reference/routing/routing/dispatch-routing-result"},{"title":"Reorder visits","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /reorder-visits","href":"/api-reference/routing/routing/reorder-visits"},{"title":"Read routing result history by result ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}/history","href":"/api-reference/routing/routing/read-routing-result-history-by-result-id"}]}]},{"group":"Flow","pages":[{"group":"Overview","pages":[{"title":"Flow","href":"/api-reference/flow/overview"},{"title":"Automation","href":"/api-reference/flow/automation-overview"}]},{"group":"Flow","pages":[{"title":"Read flows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flows","href":"/api-reference/flow/flow/read-flows"},{"title":"Read flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowId}","href":"/api-reference/flow/flow/read-flow-by-id"},{"title":"Read flow fields","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-fields","href":"/api-reference/flow/flow/read-flow-fields"},{"title":"Read flow components","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-components","href":"/api-reference/flow/flow/read-flow-components"},{"title":"Read flow component by flow name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/fields","href":"/api-reference/flow/flow/read-flow-component-by-flow-name"},{"title":"Generate example","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/task","href":"/api-reference/flow/flow/generate-example"},{"title":"Read flow histories","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-logs","href":"/api-reference/flow/flow/read-flow-histories"},{"title":"Create flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flow","href":"/api-reference/flow/flow/create-flow"},{"title":"Read flow versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flows/check-version","href":"/api-reference/flow/flow/read-flow-versions"},{"title":"Re-order flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow-reorder","href":"/api-reference/flow/flow/re-order-flow"},{"title":"Update flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flow_id}","href":"/api-reference/flow/flow/update-flow-by-id"},{"title":"Delete flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /flow/{flow_id}","href":"/api-reference/flow/flow/delete-flow-by-id"},{"title":"Restore flow by flow log ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flowId}/restore/{flowLogId}","href":"/api-reference/flow/flow/restore-flow-by-flow-log-id"}]},{"group":"Automation","pages":[{"title":"Read automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automations","href":"/api-reference/flow/automation/read-automation"},{"title":"Read log automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log","href":"/api-reference/flow/automation/read-log-automation"},{"title":"Read automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation/{automationId}","href":"/api-reference/flow/automation/read-automation-by-id"},{"title":"Create automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation","href":"/api-reference/flow/automation/create-automation"},{"title":"Retry bulk automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation-retries","href":"/api-reference/flow/automation/retry-bulk-automation"},{"title":"Update automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /automation/{automation_id}","href":"/api-reference/flow/automation/update-automation-by-id"},{"title":"Update partially automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation/{automation_id}","href":"/api-reference/flow/automation/update-partially-automation-by-id"},{"title":"Retry automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation-retry/{log_id}","href":"/api-reference/flow/automation/retry-automation-by-id"},{"title":"Delete automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /automation/{automation_id}/","href":"/api-reference/flow/automation/delete-automation-by-id"}]}]},{"group":"Workflow","pages":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/workflow/overview"}]},{"group":"Workflow","pages":[{"title":"Get All Workflows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /internal/workflows","href":"/api-reference/workflow/workflow/get-all-workflows"},{"title":"Create Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json post /internal/workflows","href":"/api-reference/workflow/workflow/create-workflow"},{"title":"Search Workflows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /internal/workflows/search","href":"/api-reference/workflow/workflow/search-workflows"},{"title":"Get Workflow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /workflow/{id}","href":"/api-reference/workflow/workflow/get-workflow-by-id"},{"title":"Update Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json put /workflow/{id}","href":"/api-reference/workflow/workflow/update-workflow"},{"title":"Delete Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json delete /workflow/{id}","href":"/api-reference/workflow/workflow/delete-workflow"},{"title":"Get Field Mapping Data","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /workflow/{id}/steps/{stepOrder}/field-mapping-data","href":"/api-reference/workflow/workflow/get-field-mapping-data"},{"title":"Validate Field Mappings","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json post /workflow/{id}/steps/{stepOrder}/validate-field-mappings","href":"/api-reference/workflow/workflow/validate-field-mappings"}]}]},{"group":"Data","pages":[{"group":"Overview","pages":[{"title":"Data","href":"/api-reference/data/overview"},{"title":"Data Source","href":"/api-reference/data/data-source-overview"},{"title":"Data Type","href":"/api-reference/data/data-type-overview"}]},{"group":"Data Source","pages":[{"title":"Read data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data","href":"/api-reference/data/data-source/read-data-source"},{"title":"Create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data","href":"/api-reference/data/data-source/create-data-source"},{"title":"Read data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-id"},{"title":"Read data source by dataTypeName and dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-datatypename-and-dataid"},{"title":"Read data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/hub/{hubId}/type/{dataTypeName}/{data_id}","href":"/api-reference/data/data-source/read-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk","href":"/api-reference/data/data-source/bulk-create-data-source"},{"title":"Bulk create or update data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk/upsert","href":"/api-reference/data/data-source/bulk-create-or-update-data-source"},{"title":"Update data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/{_id}","href":"/api-reference/data/data-source/update-data-source-by-id"},{"title":"Update data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/hub/{hub_id}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/update-data-source-by-hubid-datatypename-dataid"},{"title":"Update partially data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data/{data_id}","href":"/api-reference/data/data-source/update-partially-data-source-by-id"},{"title":"Delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/{data_id}/","href":"/api-reference/data/data-source/delete-data-source"},{"title":"Delete data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/hub/{hubId}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/delete-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /datas/bulk","href":"/api-reference/data/data-source/bulk-delete-data-source"},{"title":"Bulk patch data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /datas/bulk","href":"/api-reference/data/data-source/bulk-patch-data-source"}]},{"group":"Data Type","pages":[{"title":"Read data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types","href":"/api-reference/data/data-type/read-data-type"},{"title":"Read data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-type/{dataTypeId}/","href":"/api-reference/data/data-type/read-data-type-by-id"},{"title":"Create data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type","href":"/api-reference/data/data-type/create-data-type"},{"title":"Update data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-data-type-by-id"},{"title":"Delete data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data-type/{dataTypeId}","href":"/api-reference/data/data-type/delete-data-type-by-id"},{"title":"Update partially data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-partially-data-type-by-id"}]}]},{"group":"Setting","pages":[{"group":"Overview","pages":[{"title":"Setting","href":"/api-reference/setting/overview"},{"title":"User","href":"/api-reference/setting/user-overview"},{"title":"Team","href":"/api-reference/setting/team-overview"},{"title":"Role","href":"/api-reference/setting/role-overview"},{"title":"Hub","href":"/api-reference/setting/hub-overview"},{"title":"App Integration","href":"/api-reference/setting/app-integration-overview"},{"title":"Add-on","href":"/api-reference/setting/addon-overview"}]},{"group":"User","pages":[{"title":"Read user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /users","href":"/api-reference/setting/user/read-user"},{"title":"Read mine","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user","href":"/api-reference/setting/user/read-mine"},{"title":"Update partially user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user","href":"/api-reference/setting/user/update-partially-user"},{"title":"Read user by email","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/email/{email}","href":"/api-reference/setting/user/read-user-by-email"},{"title":"Read user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/{userId}","href":"/api-reference/setting/user/read-user-by-id"},{"title":"Update user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /user/{userId}","href":"/api-reference/setting/user/update-user"},{"title":"Update partially user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user/{userId}","href":"/api-reference/setting/user/update-partially-user-by-id"},{"title":"Read locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /members/locked","href":"/api-reference/setting/user/read-locked-user"},{"title":"Unlock locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/unlock","href":"/api-reference/setting/user/unlock-locked-user"},{"title":"Reset password user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/reset-password","href":"/api-reference/setting/user/reset-password-user"},{"title":"Delete user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /member/{userId}","href":"/api-reference/setting/user/delete-user"}]},{"group":"Team","pages":[{"title":"Read team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /teams","href":"/api-reference/setting/team/read-team"},{"title":"Read team by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /team/{teamId}","href":"/api-reference/setting/team/read-team-by-id"},{"title":"Create team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /team","href":"/api-reference/setting/team/create-team"},{"title":"Update team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /team/{teamId}/","href":"/api-reference/setting/team/update-team"},{"title":"Delete team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /team/{teamId}/","href":"/api-reference/setting/team/delete-team"}]},{"group":"Role","pages":[{"title":"Read role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /roles","href":"/api-reference/setting/role/read-role"},{"title":"Read role by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role/{roleId}","href":"/api-reference/setting/role/read-role-by-id"}]},{"group":"Hub","pages":[{"title":"Read hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hubs","href":"/api-reference/setting/hub/read-hub"},{"title":"Read hub by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hub/{hubId}/","href":"/api-reference/setting/hub/read-hub-by-id"},{"title":"Create hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /hub","href":"/api-reference/setting/hub/create-hub"},{"title":"Update hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /hub/{hubId}","href":"/api-reference/setting/hub/update-hub"},{"title":"Delete hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /hub/{hubId}","href":"/api-reference/setting/hub/delete-hub"}]},{"group":"App Integration","pages":[{"title":"Read App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integrations","href":"/api-reference/setting/app-integration/read-app-integration"},{"title":"Read App Integration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/read-app-integration-by-id"},{"title":"Create App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration","href":"/api-reference/setting/app-integration/create-app-integration"},{"title":"Update App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration/{appIntegrationId}/","href":"/api-reference/setting/app-integration/update-app-integration"},{"title":"Delete App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /app-integration/{appIntegrationId}/","href":"/api-reference/setting/app-integration/delete-app-integration"}]}]},{"group":"Import/Export","pages":[{"group":"Overview","pages":[{"title":"Import/Export","href":"/api-reference/importexport/overview"},{"title":"Data Import","href":"/api-reference/importexport/data-import-overview"},{"title":"Export Task","href":"/api-reference/importexport/export-task-overview"},{"title":"Export Config","href":"/api-reference/importexport/export-config-overview"},{"title":"Import Config","href":"/api-reference/importexport/import-config-overview"}]},{"group":"Export Task","pages":[{"title":"Get export log history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/export-log","href":"/api-reference/importexport/export-task/get-export-log-history"},{"title":"Export tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/export","href":"/api-reference/importexport/export-task/export-tasks"},{"title":"Export data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/export","href":"/api-reference/importexport/export-task/export-data-source"}]},{"group":"Data Import","pages":[{"title":"Import data source from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/import","href":"/api-reference/importexport/data-import/import-data-source-from-file"},{"title":"Read import monitoring records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring","href":"/api-reference/importexport/data-import/read-import-monitoring-records"},{"title":"Read import monitoring record by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring/{id}","href":"/api-reference/importexport/data-import/read-import-monitoring-record-by-id"}]},{"group":"Export Config","pages":[{"title":"Read export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-configs","href":"/api-reference/importexport/export-config/read-export-config"},{"title":"Read export config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-config/{exportConfigId}","href":"/api-reference/importexport/export-config/read-export-config-by-id"},{"title":"Create export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /export-config","href":"/api-reference/importexport/export-config/create-export-config"},{"title":"Update export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/update-export-config"},{"title":"Delete export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/delete-export-config"}]},{"group":"Import Config","pages":[{"title":"Read import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs","href":"/api-reference/importexport/import-config/read-import-config"},{"title":"Read import config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-config/{importConfigId}","href":"/api-reference/importexport/import-config/read-import-config-by-id"},{"title":"Create import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /import-config","href":"/api-reference/importexport/import-config/create-import-config"},{"title":"Update import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /import-config/{importConfigId}/","href":"/api-reference/importexport/import-config/update-import-config"},{"title":"Delete import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /import-config/{importConfigId}/","href":"/api-reference/importexport/import-config/delete-import-config"}]}]},{"group":"File","pages":[{"title":"Overview","href":"/api-reference/file/overview"},{"group":"File","pages":[{"title":"View file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-file.json get /file/view","href":"/api-reference/file/file/view-file"}]}]},{"group":"Auth","pages":[{"group":"Overview","pages":[{"title":"Multi-Organization","href":"/api-reference/auth/multi-organization-overview"}]},{"group":"Multi-Organization","pages":[{"title":"Get User Organizations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json get /organizations","href":"/api-reference/auth/multi-organization/get-user-organizations"},{"title":"Switch Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization/switch","href":"/api-reference/auth/multi-organization/switch-organization"},{"title":"Create Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization","href":"/api-reference/auth/multi-organization/create-organization"}]}]},{"group":"Objects","pages":[{"title":"Task object","href":"/api-reference/objects/task-object"},{"title":"Location history object","href":"/api-reference/objects/location-history-object"},{"title":"Export Config object","href":"/api-reference/objects/export-config-object"},{"title":"Task Schedule object","href":"/api-reference/objects/task-schedule-object"},{"title":"Vehicle object","href":"/api-reference/objects/vehicle-object"},{"title":"Routing object","href":"/api-reference/objects/routing-object"},{"title":"Flow object","href":"/api-reference/objects/flow-object"},{"title":"Workflow object","description":null,"href":"/api-reference/objects/workflow-object"},{"title":"Automation object","href":"/api-reference/objects/automation-object"},{"title":"Data source object","description":null,"href":"/api-reference/objects/data-source-object"},{"title":"Data type object","href":"/api-reference/objects/data-type-object"},{"title":"User object","href":"/api-reference/objects/user-object"},{"title":"Role object","href":"/api-reference/objects/role-object"},{"title":"Hub object","href":"/api-reference/objects/hub-object"},{"title":"Team object","href":"/api-reference/objects/team-object"},{"title":"Add-on object","href":"/api-reference/objects/addon-object"}]}]},{"tab":"Internal API","hidden":true,"pages":[{"title":"Internal API","href":"/api-reference-internal/introduction"}]}]},"basePath":"","title":"Automation object - Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}