Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Update Checklist Information

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"blueprint[0].transition_id","1000000034304")
    CkJsonObject::ckUpdateBool(json,"blueprint[0].data.CheckLists[0]." + Chr(34) + "list 1" + Chr(34),1)
    CkJsonObject::ckUpdateBool(json,"blueprint[0].data.CheckLists[1]." + Chr(34) + "list 2" + Chr(34),0)
    CkJsonObject::ckUpdateBool(json,"blueprint[0].data.CheckLists[2]." + Chr(34) + "list 3" + Chr(34),1)
    CkJsonObject::ckUpdateBool(json,"blueprint[0].data.CheckLists[3]." + Chr(34) + "list 4" + Chr(34),1)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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