Chilkat Online Tools

delphiDll / Zoho CRM REST APIs / Update Checklist Information

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

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

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'blueprint[0].transition_id','1000000034304');
CkJsonObject_UpdateBool(json,'blueprint[0].data.CheckLists[0]."list 1"',True);
CkJsonObject_UpdateBool(json,'blueprint[0].data.CheckLists[1]."list 2"',False);
CkJsonObject_UpdateBool(json,'blueprint[0].data.CheckLists[2]."list 3"',True);
CkJsonObject_UpdateBool(json,'blueprint[0].data.CheckLists[3]."list 4"',True);

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

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