Chilkat Online Tools

Foxpro / Zoho CRM REST APIs / Update Checklist Information

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "blueprint": [
*     {
*       "transition_id": "1000000034304",
*       "data": {
*         "CheckLists": [
*           {
*             "list 1": true
*           },
*           {
*             "list 2": false
*           },
*           {
*             "list 3": true
*           },
*           {
*             "list 4": true
*           }
*         ]
*       }
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("blueprint[0].transition_id","1000000034304")
loJson.UpdateBool('blueprint[0].data.CheckLists[0]."list 1"',1)
loJson.UpdateBool('blueprint[0].data.CheckLists[1]."list 2"',0)
loJson.UpdateBool('blueprint[0].data.CheckLists[2]."list 3"',1)
loJson.UpdateBool('blueprint[0].data.CheckLists[3]."list 4"',1)

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "blueprint": [
        {
            "transition_id": "1000000034304",
            "data": {
                "CheckLists": [
                    {
                        "list 1": true
                    },
                    {
                        "list 2": false
                    },
                    {
                        "list 3": true
                    },
                    {
                        "list 4": true
                    }
                ]
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint

Postman Collection Item JSON

{
  "name": "Update Checklist Information",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"blueprint\": [\n        {\n            \"transition_id\": \"1000000034304\",\n            \"data\": {\n                \"CheckLists\": [\n                    {\n                        \"list 1\": true\n                    },\n                    {\n                        \"list 2\": false\n                    },\n                    {\n                        \"list 3\": true\n                    },\n                    {\n                        \"list 4\": true\n                    }\n                ]\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Leads/{{record_id}}/actions/blueprint",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Leads",
        "{{record_id}}",
        "actions",
        "blueprint"
      ]
    },
    "description": "To update a single transition at a time. An error is thrown if the record is not in transition, transition_id is wrong, field_value data type mismatches, or field validation fails."
  },
  "response": [
  ]
}