ChakraHQ APIs
HomeSign In
HomeSign In
  1. Process
  • API Keys
  • Response Format
  • Whatsapp
    • Inbound Events Webhook
    • Pass Through APIs
      • Create WhatsApp Message Template (pass-through)
      • List WhatsApp Message Templates (pass-through)
      • Update WhatsApp Message Template (pass-through)
      • Whatsapp Messages API (pass-through)
    • Send Whatsapp Template Message For Process
      POST
    • Send Whatsapp Template Message For A Phone Number
      POST
    • Upload Public Media
      POST
  • Platform
    • Process
      • Fetch Process By Id
        GET
      • List Processes
        POST
      • Create Process
        POST
      • Update Process
        PUT
      • Update Process By Primary Key
        PUT
      • Delete Process
        DELETE
      • Delete Process By Primary Key Value
        DELETE
      • Bulk Create Process API
        POST
      • Bulk Update Process API
        PATCH
    • Task
      • Create Task API
    • User
      • List Users API
      • List Users API (V2)
      • Fetch User API
      • Fetch User API (V2)
      • Update User API
    • Photo
      • Fetch Photo API
      • Upload Photo API
      • Upload Photo API With Id
    • Background Job
      • Fetch Background Job
      • Fetch Background Job Entries API
    • Fetch Config
      GET
  1. Process

Create Process

POST
https://api.chakrahq.com/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 TypeData Format
External ObjectPass a json object exactly matching the external object schema
PhotoPass 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

Body Params application/json

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 Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.chakrahq.com/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

Example
{}
Modified at 2025-05-12 09:05:09
Previous
List Processes
Next
Update Process
Built with