Chilkat Online Tools

phpExt / Zoho CRM REST APIs / Events

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$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.

// {
//   "data": [
//     {
//       "Owner": {
//         "id": "{{user-id}}"
//       },
//       "Who_Id": {
//         "id": "{{contact-id}}"
//       },
//       "What_Id": {
//         "id": "{{record-id}}"
//       },
//       "$se_module": "{{record-module}}",
//       "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
//       "Venue": "Venue",
//       "Start_DateTime": "2018-01-27T15:10:00+05:30",
//       "Participants": [
//         {
//           "type": "lead",
//           "participant": "1000000071949"
//         },
//         {
//           "type": "contact",
//           "participant": "1000000071957"
//         },
//         {
//           "type": "email",
//           "participant": "newcrmapi@zoho.com"
//         },
//         {
//           "type": "user",
//           "participant": "1000000030977"
//         }
//       ],
//       "Event_Title": "Event_Title",
//       "send_notification": true,
//       "End_DateTime": "2018-01-27T17:10:00+05:30"
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('data[0].Owner.id','{{user-id}}');
$json->UpdateString('data[0].Who_Id.id','{{contact-id}}');
$json->UpdateString('data[0].What_Id.id','{{record-id}}');
$json->UpdateString('data[0].$se_module','{{record-module}}');
$json->UpdateString('data[0].Description','Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.');
$json->UpdateString('data[0].Venue','Venue');
$json->UpdateString('data[0].Start_DateTime','2018-01-27T15:10:00+05:30');
$json->UpdateString('data[0].Participants[0].type','lead');
$json->UpdateString('data[0].Participants[0].participant','1000000071949');
$json->UpdateString('data[0].Participants[1].type','contact');
$json->UpdateString('data[0].Participants[1].participant','1000000071957');
$json->UpdateString('data[0].Participants[2].type','email');
$json->UpdateString('data[0].Participants[2].participant','newcrmapi@zoho.com');
$json->UpdateString('data[0].Participants[3].type','user');
$json->UpdateString('data[0].Participants[3].participant','1000000030977');
$json->UpdateString('data[0].Event_Title','Event_Title');
$json->UpdateBool('data[0].send_notification',true);
$json->UpdateString('data[0].End_DateTime','2018-01-27T17:10:00+05:30');

$http->SetRequestHeader('Authorization','{{authorization-token}}');
$http->SetRequestHeader('Content-Type','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/crm/v2/Events/{{record-id}}',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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}}",
			"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
			"Venue": "Venue",
			"Start_DateTime": "2018-01-27T15:10:00+05:30",
			"Participants": [
				{
					"type": "lead",
					"participant": "1000000071949"
				},
				{
					"type": "contact",
					"participant": "1000000071957"
				},
				{
					"type": "email",
					"participant": "newcrmapi@zoho.com"
				},
				{
					"type": "user",
					"participant": "1000000030977"
				}
			],
			"Event_Title": "Event_Title",
			"send_notification": true,
			"End_DateTime": "2018-01-27T17:10:00+05:30"
		}
	]
}'
https://domain.com/crm/v2/Events/{{record-id}}

Postman Collection Item JSON

{
  "name": "Events",
  "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\"Description\": \"Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.\",\n\t\t\t\"Venue\": \"Venue\",\n\t\t\t\"Start_DateTime\": \"2018-01-27T15:10:00+05:30\",\n\t\t\t\"Participants\": [\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"lead\",\n\t\t\t\t\t\"participant\": \"1000000071949\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"contact\",\n\t\t\t\t\t\"participant\": \"1000000071957\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"email\",\n\t\t\t\t\t\"participant\": \"newcrmapi@zoho.com\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"user\",\n\t\t\t\t\t\"participant\": \"1000000030977\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"Event_Title\": \"Event_Title\",\n\t\t\t\"send_notification\": true,\n\t\t\t\"End_DateTime\": \"2018-01-27T17:10:00+05:30\"\n\t\t}\n\t]\n}"
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Events/{{record-id}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Events",
        "{{record-id}}"
      ]
    },
    "description": "To update existing entities in the module."
  },
  "response": [
  ]
}