Chilkat Online Tools

TCL / Zoho CRM REST APIs / Update Checklist Information

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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
#           }
#         ]
#       }
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "blueprint[0].transition_id" "1000000034304"
CkJsonObject_UpdateBool $json "blueprint[0].data.CheckLists[0].\"list 1\"" 1
CkJsonObject_UpdateBool $json "blueprint[0].data.CheckLists[1].\"list 2\"" 0
CkJsonObject_UpdateBool $json "blueprint[0].data.CheckLists[2].\"list 3\"" 1
CkJsonObject_UpdateBool $json "blueprint[0].data.CheckLists[3].\"list 4\"" 1

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "PUT" "https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp

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": [
  ]
}