ChakraHQ APIs

Create Task API

POST

/v1/ext/p/{procedureShortId}/{processIdOrPrimaryKey}/task/{stateTaskShortId}

The following API allow you to creat a task for a process.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

procedureShortId

string

required

The procedure shortId of the procedure of the process for which the task is to be created

Example:

lead

processIdOrPrimaryKey

string

required

The process id or the primary key value

Example:

LEAD-000042

stateTaskShortId

string

required

Task short id

Example:

call

Body Params application/json

data

object

optional

pass the task data as an object. keys should be task attribute short ids

call_disposition

string

optional

Sample task field

next_call_time

string

optional

Sample task field

remarks

string

optional

Sample task field

status

string

optional

the status of the task - can be one of OPEN, COMPLETED or CANCELLED.

assignedTo

string

optional

the username of the user to whom the task is assigne to

Example

{
  "data": {
    "call_disposition": "RNR",
    "next_call_time": "2023-11-15T09:30:00",
    "remarks": "Couldnt reach out to the customer"
  },
  "status": "COMPLETED",
  "assignedTo": "alex@paisapay.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/ext/p/lead/LEAD-000042/task/call' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "call_disposition": "RNR",
    "next_call_time": "2023-11-15T09:30:00",
    "remarks": "Couldnt reach out to the customer"
  },
  "status": "COMPLETED",
  "assignedTo": "alex@paisapay.com"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-11-11 10:50:10

Bulk Update Process API

List Users API