Bulk Update Process API

The following API allows you to update multiple processes in a single API call. This API is asynchronous - meaning the request is accepted and an acknowledgment is returned while the updates are carried out in the background. Use this api when you have to update 1000s of processes in one go.

Request Body

In the request body you need to pass a list of processes which are to be updated. Each update item will need the following parts

Process Identifier

A way to identify the process which needs to be updated. The identifier can be the process id or the process primary key

Eg:

"id": "LEAD-001"

"phone_number": "9901258433"

Where phone_number is the primary key for the corresponding procedure

update

The actual update to be made. The update inputs need to be encapuslated and sent against the key "update". Supported parameters that can be updated are

data - a json object composed of attribute shortIds and the values that are to be updated

Eg:

{
  "data": {
		"score": 42,
    "city": "Bangalore",
    "name": "Shane Warne"
	}
}

state - the process state

Eg:

{
  "state": "IN_PROGRESS"
}

status - the process status

Eg:

{
	"status": "CANCELLED"
}

status can be one of OPEN, COMPLETED, CANCELLED

assignedTo - who the process is assignedTo

Eg:

{
  assignedTo: "shane.warne"
}

nextActionAt - the nextActionAt timestamp in epoch milliseconds

Eg:

{
  "nextActionAt": 1616253910842
}

isDeleted - set isDeleted to true to delete a process

Eg:

{
  "isDeleted": true
}

Following are valid examples of the request body

{
  "processes": [
    {
      "id": "46ce67e5-684e-4cfc-b47e-345a485d1cdd",
      "state": "IN_PROGRESS",
      "status": "OPEN",
      "assignedTo": "shane.warne",
      "nextActionAt": "1616253910842",
      "data": {
        "first_name": "shane",
        "last_name": "warne"
      }
    }
  ]
}

{
  "processes": [
    {
      "lead_id": "LEAD-910",
      "data": {
        "country": "Japan",
        "city": "Tokyo"
      }
    }
  ]
}

{
  "processes": [
    {
      "status": "COMPLETED"
    }
  ]
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

Body

processes

array [object {3}]

required

lead_id

string

optional

update

object

required

string

optional

Example

{
  "processes": [
    {
      "lead_id": "string",
      "update": {
        "data": {
          "score": "string",
          "city": "string"
        },
        "state": "string"
      },
      "id": "string"
    }
  ]
}

Request Body

Process Identifier

update

Request

Request samples

Responses

Bulk Update Process API

Request Body#

Process Identifier#

update#

Request

Request samples

Responses

Request Body

Process Identifier

update