ChakraHQ APIs

Update Process By Primary Key

PUT

/v1/ext/procedure/{procedureShortId}/process/{primaryKeyShortId}/{primaryKeyValue}

This API allow you to update a single process. A process can be updated basis its primaryKey value.

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 short if of the procedure to which this process belongs

Example:

lead

primaryKeyShortId

string

required

The attribute short id of the primary key attribute

Example:

lead_id

primaryKeyValue

string

required

The primary key value by which you want to lookup the process. to update

Example:

LEAD-000042

Body Params application/json

data

object

optional

should be an object. keys should be attribute short ids. value should denote the update value for the provided attribute

firstname

string

optional

lastname

string

optional

score

integer

optional

status

string

optional

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

state

string

optional

the updated state - the list of possible states depends on the procedure to which this process belongs

nextActionAt

integer

optional

accepts a unix epoch timestamp in milliseconds. This value updates the nextActionAt field of a process

Example

{
  "data": {
    "firstname": "Ted",
    "lastname": "Mosby",
    "score": 5
  },
  "status": "COMPLETED",
  "state": "CONVERTED",
  "nextActionAt": 1618558867539
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/ext/procedure/lead/process/lead_id/LEAD-000042' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "firstname": "Ted",
    "lastname": "Mosby",
    "score": 5
  },
  "status": "COMPLETED",
  "state": "CONVERTED",
  "nextActionAt": 1618558867539
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-11-11 10:37:36

Update Process

Delete Process