Skip to main content
PATCH
/
task
/
schedule
/
{scheduleId}
Update partially task schedule by ID
curl --request PATCH \
  --url https://apiweb.mile.app/api/v3/task/schedule/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hubId": "634e98498ce07d29474a7e29",
  "name": "Daily Morning Visit 3",
  "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"
}
'
{
  "status": true,
  "message": "Update data success",
  "data": {
    "hubId": "634e98498ce07d29474a7e29",
    "name": "Daily Morning Visit 3",
    "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"
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

ā€‹
scheduleId
string
required

Unique identifier for the task schedule that generated by system. Example: 6352736c628401059b37a2e2

Body

application/json
ā€‹
hubId
string

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

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

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

ā€‹
flow
string

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

ā€‹
startTime
string

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

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

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

ā€‹
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
ā€‹
schedules
object[]

Object with format according to value of periode. Configuration for the time of task scheduler will run. Example for periode of daily: [{ 'time':['07:00'] }] Example for periode of weekly: [{ 'day':'sunday', 'time':['07:00'] }] Example for periode of monthly: [{ 'date':'1', 'time':['07:00'] }] Example for periode of byDate: [{ 'date':'2022-11-03', 'time':['07:00'] }]

Response

Success

ā€‹
status
boolean

Status of response.

ā€‹
message
string

Message of API response.

ā€‹
data
object

Detail of object task schedule.