Create task schedule

curl --request POST \
  --url https://apiweb.mile.app/api/v3/task/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hubId": "<string>",
  "name": "<string>",
  "periode": "<string>",
  "flow": "<string>",
  "flowId": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "task": {},
  "assignee": "<array>",
  "interval": 50
}
'

import requests

url = "https://apiweb.mile.app/api/v3/task/schedule"

payload = {
    "hubId": "<string>",
    "name": "<string>",
    "periode": "<string>",
    "flow": "<string>",
    "flowId": "<string>",
    "startTime": "<string>",
    "endTime": "<string>",
    "task": {},
    "assignee": "<array>",
    "interval": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hubId: '<string>',
    name: '<string>',
    periode: '<string>',
    flow: '<string>',
    flowId: '<string>',
    startTime: '<string>',
    endTime: '<string>',
    task: {},
    assignee: '<array>',
    interval: 50
  })
};

fetch('https://apiweb.mile.app/api/v3/task/schedule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiweb.mile.app/api/v3/task/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hubId' => '<string>',
    'name' => '<string>',
    'periode' => '<string>',
    'flow' => '<string>',
    'flowId' => '<string>',
    'startTime' => '<string>',
    'endTime' => '<string>',
    'task' => [
        
    ],
    'assignee' => '<array>',
    'interval' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apiweb.mile.app/api/v3/task/schedule"

	payload := strings.NewReader("{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apiweb.mile.app/api/v3/task/schedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apiweb.mile.app/api/v3/task/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Task Scheduler has been created",
  "data": {
    "hubId": "634e98498ce07d29474a7e29",
    "name": "Daily Morning Visit",
    "periode": "daily",
    "flow": "Visit",
    "flowId": "67be687c128306111e022022",
    "task": {
      "receiverName": "Miguel",
      "address": "gambir jakarta pusat",
      "coordinates": "",
      "weight": "5"
    },
    "schedules": [
      {
        "time": [
          "07:00"
        ]
      }
    ],
    "startTime": "2022-11-02",
    "endTime": "2022-11-05",
    "createdBy": "Pablo",
    "timeSchedules": [
      "07:00"
    ],
    "organizationId": "634e98098ce07d29474a7e22",
    "updatedTime": "2022-11-01T07:28:23+00:00",
    "createdTime": "2022-11-01T07:28:23+00:00",
    "_id": "6352736c628401059b37a2e2"
  }
}

{
  "status": false,
  "message": "Bad request - invalid parameters provided."
}

{
  "status": false,
  "message": "Internal server error, please contact support@mile.app."
}

POST

task

schedule

Create task schedule

curl --request POST \
  --url https://apiweb.mile.app/api/v3/task/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hubId": "<string>",
  "name": "<string>",
  "periode": "<string>",
  "flow": "<string>",
  "flowId": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "task": {},
  "assignee": "<array>",
  "interval": 50
}
'

import requests

url = "https://apiweb.mile.app/api/v3/task/schedule"

payload = {
    "hubId": "<string>",
    "name": "<string>",
    "periode": "<string>",
    "flow": "<string>",
    "flowId": "<string>",
    "startTime": "<string>",
    "endTime": "<string>",
    "task": {},
    "assignee": "<array>",
    "interval": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hubId: '<string>',
    name: '<string>',
    periode: '<string>',
    flow: '<string>',
    flowId: '<string>',
    startTime: '<string>',
    endTime: '<string>',
    task: {},
    assignee: '<array>',
    interval: 50
  })
};

fetch('https://apiweb.mile.app/api/v3/task/schedule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiweb.mile.app/api/v3/task/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hubId' => '<string>',
    'name' => '<string>',
    'periode' => '<string>',
    'flow' => '<string>',
    'flowId' => '<string>',
    'startTime' => '<string>',
    'endTime' => '<string>',
    'task' => [
        
    ],
    'assignee' => '<array>',
    'interval' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apiweb.mile.app/api/v3/task/schedule"

	payload := strings.NewReader("{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apiweb.mile.app/api/v3/task/schedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apiweb.mile.app/api/v3/task/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hubId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"periode\": \"<string>\",\n  \"flow\": \"<string>\",\n  \"flowId\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"task\": {},\n  \"assignee\": \"<array>\",\n  \"interval\": 50\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Task Scheduler has been created",
  "data": {
    "hubId": "634e98498ce07d29474a7e29",
    "name": "Daily Morning Visit",
    "periode": "daily",
    "flow": "Visit",
    "flowId": "67be687c128306111e022022",
    "task": {
      "receiverName": "Miguel",
      "address": "gambir jakarta pusat",
      "coordinates": "",
      "weight": "5"
    },
    "schedules": [
      {
        "time": [
          "07:00"
        ]
      }
    ],
    "startTime": "2022-11-02",
    "endTime": "2022-11-05",
    "createdBy": "Pablo",
    "timeSchedules": [
      "07:00"
    ],
    "organizationId": "634e98098ce07d29474a7e22",
    "updatedTime": "2022-11-01T07:28:23+00:00",
    "createdTime": "2022-11-01T07:28:23+00:00",
    "_id": "6352736c628401059b37a2e2"
  }
}

{
  "status": false,
  "message": "Bad request - invalid parameters provided."
}

{
  "status": false,
  "message": "Internal server error, please contact support@mile.app."
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Body

application/json

hubId

string

required

Fundamental entity within an organization, serving as the central point for managing various operational components. Use GET /hubs endpoint to get the list of Hub IDs. Example: 634e98498ce07d29474a7e29

name

string

required

The name of task schedule. User can define task schedule name with task's flow name combined with running time, or something else. Example: Daily Morning Visit

periode

string

required

There are 5 types of periode: daily, weekly, monthly, byDate, custom. Period of time when the task scheduler running. Example: daily

flow

string

required

The unique name of organization's flow. Use Flow /flows API to get the list of flow names. Example: Visit

flowId

string

required

The Identifier of organization's flow. Use Flow /flows API to get the list of flow ids. Example: 67be687c128306111e022022

startTime

string

required

Start date of task scheduler to active. this field only available when periode's value is one of: daily, weekly, monthly Example: 2022-11-02

endTime

string

required

End date of task scheduler to active. this field only available when periode's value is one of: daily, weekly, monthly Example: 2022-11-05

task

object

required

data of task according to selected flow. Example: { 'receiverName':'miguel', 'coordinates':'-6.230815251,106.75684387', 'address':'rawamangun jakarta timur' }

assignee

array

List of user email that will be assigned to the generated task. Example: ['jhon@sample.com']

interval

integer | null

Number units of frequency between each scheduled execution. For example, an interval of 2 with a frequency of daily means the task will run every 2 days. This required when select the custom periode. Example: daily

Required range: 1 <= x <= 99

frequency

enum<string> | null

Specified unit of time for the scheduling interval. Determines how often the scheduled task will run based on the interval value.This required when select the custom periode. Example: daily

Available options:

daily,

weekly,

monthly

Response

Success

status

boolean

Status of response.

message

string

Message of API response.

data

object

Detail of object task schedule.

Read task schedule by ID Bulk create task schedule

Getting Started

Tools

Webhook

Task

Routing

Flow

Workflow

Data

Setting

Import/Export

File

Auth

Objects

Authorizations

Body

Response