Update Process

PUT/v1/ext/procedure/{procedureShortId}/process/{processId}

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

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

procedureShortId

string

required

The short if of the procedure to which this process belongs

Example:

lead

processId

string

required

The internal process id of the process

Example:

3396ea03-cc82-4a52-967b-dc2a94b50f12

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

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

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

object {0}

{}

Last modified: 2 months ago