Create multiple tasks

curl --request POST \
  --url https://apiweb.mile.app/api/v3/tasks/bulk/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "background": false,
  "tasks": [
    {
      "flow": "Visit",
      "hubId": "634e98498ce07d29474a7e29",
      "field1": "Jack Ward",
      "field2": "Gambir Jakarta",
      "field3": "-6.230815251,106.75684387",
      "startTime": "2022-11-02T07:28:23+00:00",
      "endTime": "2022-11-05T07:28:23+00:00"
    },
    {
      "flow": "Visit",
      "hubId": "634e98498ce07d29474a7e29",
      "field1": "John Birdy",
      "refId": "66544e0855d2696d401d8252"
    }
  ]
}
'

{
  "success": 2,
  "failed": 0,
  "tasks": [
    {
      "status": true,
      "message": "Task has been created",
      "_id": "62067ee1cd77000042006f89"
    },
    {
      "status": true,
      "message": "Task has been created",
      "_id": "62067ee3cd77000042006f8b",
      "refId": "66544e0855d2696d401d8252"
    }
  ]
}

POST

tasks

bulk

Create multiple tasks

curl --request POST \
  --url https://apiweb.mile.app/api/v3/tasks/bulk/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "background": false,
  "tasks": [
    {
      "flow": "Visit",
      "hubId": "634e98498ce07d29474a7e29",
      "field1": "Jack Ward",
      "field2": "Gambir Jakarta",
      "field3": "-6.230815251,106.75684387",
      "startTime": "2022-11-02T07:28:23+00:00",
      "endTime": "2022-11-05T07:28:23+00:00"
    },
    {
      "flow": "Visit",
      "hubId": "634e98498ce07d29474a7e29",
      "field1": "John Birdy",
      "refId": "66544e0855d2696d401d8252"
    }
  ]
}
'

{
  "success": 2,
  "failed": 0,
  "tasks": [
    {
      "status": true,
      "message": "Task has been created",
      "_id": "62067ee1cd77000042006f89"
    },
    {
      "status": true,
      "message": "Task has been created",
      "_id": "62067ee3cd77000042006f8b",
      "refId": "66544e0855d2696d401d8252"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Body

application/json

tasks

object[]

required

The maximum data for creating multiple tasks is 2000 data.

Show child attributes

tasks.flow

string

required

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

tasks.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

tasks.field1

string

This field's type & value is according to Flow's setting. Use GET /flow/{flowName}/task API to get example of payload. Example: Jack Ward

tasks.field2

string

This field's type & value is according to Flow's setting. Use GET /flow/{flowName}/task API to get example of payload. Example: Gambir Jakarta

tasks.field3

string

This field's type & value is according to Flow's setting. Use GET /flow/{flowName}/task API to get example of payload. Example: -6.230815251,106.75684387

tasks.startTime

string<date-time>

Start time refers to the designated time for users to begin a task. If startTime is not provided, it will default to the configured time in the flow. You can view the datetime format here. Example: 2022-11-02T07:28:23+00:00

tasks.endTime

string<date-time>

End time is the deadline for completing a task. If endTime is not specified, it will default to the configured time in the flow.The task cannot be completed if the date has passed the endtime. You can view the datetime format here Example: 2022-11-05T07:28:23+00:00

tasks.assignee

object[]

You can assign tasks using user email according to their task hub. To assign tasks to multiple users, use a comma (',') as a separator. Example: ['leandro@mile.app']

tasks.refId

string

You can add refId to return a value as a task reference . Example: 66544e0855d2696d401d8252

background

boolean

When the background parameter is set to true , the action will be processed in the background. In this mode, the API call will return quickly with a response indicating that the create task request has been received and is being processed asynchronously in the background. When the background parameter is set to false (default), the create task will be processed directly via API. This means that the API call will wait for the create task process to complete before returning the results to the user. Default: false.

Response

Success

success

integer

Total success created task.

failed

integer

Total failed created task.

tasks

object[]

Detail of created task.

Show child attributes

tasks.status

boolean

Status of response.

tasks._id

string

Task ID

tasks.message

string

Message of create task

tasks.refId

string

Reference id of create task

Create task Upload image for task

⌘I

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects

Authorizations

Body

Response