Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Tasks

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.

    ; {
    ;   "data": [
    ;     {
    ;       "Owner": {
    ;         "id": "{{user-id}}"
    ;       },
    ;       "Who_Id": {
    ;         "id": "{{contact-id}}"
    ;       },
    ;       "What_Id": {
    ;         "id": "{{record-id}}"
    ;       },
    ;       "$se_module": "{{record-module}}",
    ;       "Status": "In Progress",
    ;       "Send_Notification_Email": true,
    ;       "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
    ;       "Due_Date": "2018-01-25",
    ;       "Priority": "Low",
    ;       "send_notification": true,
    ;       "Subject": "Subject",
    ;       "Remind_At": {
    ;         "ALARM": "FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:2018-01-25T17:09:00+05:30"
    ;       }
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"data[0].Owner.id","{{user-id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Who_Id.id","{{contact-id}}")
    CkJsonObject::ckUpdateString(json,"data[0].What_Id.id","{{record-id}}")
    CkJsonObject::ckUpdateString(json,"data[0].$se_module","{{record-module}}")
    CkJsonObject::ckUpdateString(json,"data[0].Status","In Progress")
    CkJsonObject::ckUpdateBool(json,"data[0].Send_Notification_Email",1)
    CkJsonObject::ckUpdateString(json,"data[0].Description","Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.")
    CkJsonObject::ckUpdateString(json,"data[0].Due_Date","2018-01-25")
    CkJsonObject::ckUpdateString(json,"data[0].Priority","Low")
    CkJsonObject::ckUpdateBool(json,"data[0].send_notification",1)
    CkJsonObject::ckUpdateString(json,"data[0].Subject","Subject")
    CkJsonObject::ckUpdateString(json,"data[0].Remind_At.ALARM","FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:2018-01-25T17:09:00+05:30")

    CkHttp::ckSetRequestHeader(http,"Authorization","{{authorization-token}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    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/Tasks/{{record-id}}",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>"
	-H "Authorization: {{authorization-token}}"
	-H "Content-Type: application/json"
	-d '{
	"data": [
		{
			"Owner": {
				"id": "{{user-id}}"
			},
			"Who_Id": {
				"id": "{{contact-id}}"
			},
			"What_Id": {
				"id": "{{record-id}}"
			},
			"$se_module": "{{record-module}}",
			"Status": "In Progress",
			"Send_Notification_Email": true,
			"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
			"Due_Date": "2018-01-25",
			"Priority": "Low",
			"send_notification": true,
			"Subject": "Subject",
			"Remind_At": {
				"ALARM": "FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:2018-01-25T17:09:00+05:30"
			}
		}
	]
}'
https://domain.com/crm/v2/Tasks/{{record-id}}

Postman Collection Item JSON

{
  "name": "Tasks",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "{{authorization-token}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"data\": [\n\t\t{\n\t\t\t\"Owner\": {\n\t\t\t\t\"id\": \"{{user-id}}\"\n\t\t\t},\n\t\t\t\"Who_Id\": {\n\t\t\t\t\"id\": \"{{contact-id}}\"\n\t\t\t},\n\t\t\t\"What_Id\": {\n\t\t\t\t\"id\": \"{{record-id}}\"\n\t\t\t},\n\t\t\t\"$se_module\": \"{{record-module}}\",\n\t\t\t\"Status\": \"In Progress\",\n\t\t\t\"Send_Notification_Email\": true,\n\t\t\t\"Description\": \"Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.\",\n\t\t\t\"Due_Date\": \"2018-01-25\",\n\t\t\t\"Priority\": \"Low\",\n\t\t\t\"send_notification\": true,\n\t\t\t\"Subject\": \"Subject\",\n\t\t\t\"Remind_At\": {\n\t\t\t\t\"ALARM\": \"FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:2018-01-25T17:09:00+05:30\"\n\t\t\t}\n\t\t}\n\t]\n}"
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Tasks/{{record-id}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Tasks",
        "{{record-id}}"
      ]
    },
    "description": "To update existing entities in the module."
  },
  "response": [
  ]
}