phpAx / Zoho CRM REST APIs / Inserting an Event record and associating the What_Id through an external field
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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": [
// {
// "se_module": "Accounts",
// "What_Id": {
// "External_Account_ID": "useraccount1"
// },
// "Event_Title": "Event Kaizen",
// "Start_DateTime": "2020-05-10T10:10:10+05:30",
// "End_DateTime": "2020-05-10T11:10:10+05:30"
// }
// ]
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('data[0].se_module','Accounts');
$json->UpdateString('data[0].What_Id.External_Account_ID','useraccount1');
$json->UpdateString('data[0].Event_Title','Event Kaizen');
$json->UpdateString('data[0].Start_DateTime','2020-05-10T10:10:10+05:30');
$json->UpdateString('data[0].End_DateTime','2020-05-10T11:10:10+05:30');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('X-EXTERNAL','Events.External_ID');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2/Events','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-EXTERNAL: Events.External_ID"
-d '{
"data": [
{
"se_module": "Accounts",
"What_Id": {
"External_Account_ID": "useraccount1"
},
"Event_Title": "Event Kaizen",
"Start_DateTime": "2020-05-10T10:10:10+05:30",
"End_DateTime": "2020-05-10T11:10:10+05:30"
}
]
}'
https://domain.com/crm/v2/Events
Postman Collection Item JSON
{
"name": "Inserting an Event record and associating the What_Id through an external field",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "X-EXTERNAL",
"value": "Events.External_ID",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"se_module\": \"Accounts\",\n \"What_Id\": {\n \"External_Account_ID\": \"useraccount1\"\n },\n \"Event_Title\": \"Event Kaizen\",\n \"Start_DateTime\": \"2020-05-10T10:10:10+05:30\",\n \"End_DateTime\": \"2020-05-10T11:10:10+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Events",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Events"
]
},
"description": "In this example, External_Account_ID is the API name of the external field in the Accounts module. What_Id in the Events module takes the Account's name as its value. We will reference this external field in the Accounts module to the What_Id field and insert an event."
},
"response": [
]
}