Create Process

POST

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

This API allow you to create a single process. Examples of a process are models like Lead, Ticket and Fieldvisit

Attribute specific data

Depending on your attribute type you have to pass the value in the specific format in the data field.

Attribute Type	Data Format
External Object	Pass a json object exactly matching the external object schema
Photo	Pass a photo id generated after uploading a photo via the upload photo API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

procedureShortId

string

required

Example:

lead

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

required

lastname

string

required

score

integer

required

record

optional

Any of

object

string

the record for which this process is getting created. For example lead process usually get created for a customer record. So you need to define the record info (usually data) inside the record json

data

object

required

status

string

optional

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

state

string

optional

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

assignedTo

string

optional

Username or id of the user

Example

{
  "data": {
    "firstname": "Ted",
    "lastname": "Mosby",
    "score": 5
  },
  "record": {
    "data": {
      "phone_number": "7701214822",
      "email": "ted.mosby@yahoo.com"
    }
  },
  "status": "COMPLETED",
  "state": "CONVERTED",
  "nextActionAt": 1618558867539,
  "assignedTo": "john@paisapay.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/ext/procedure/lead/process' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "firstname": "Ted",
    "lastname": "Mosby",
    "score": 5
  },
  "record": {
    "data": {
      "phone_number": "7701214822",
      "email": "ted.mosby@yahoo.com"
    }
  },
  "status": "COMPLETED",
  "state": "CONVERTED",
  "nextActionAt": 1618558867539,
  "assignedTo": "john@paisapay.com"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-11-16 14:34:03

List Processes

Update Process

Create Process

Attribute specific data#

Request

Request samples

Responses

Attribute specific data