Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Events

Back to Collection Items

IncludeFile "CkJsonObject.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}}",
    ;       "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.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].Description","Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.")
    CkJsonObject::ckUpdateString(json,"data[0].Venue","Venue")
    CkJsonObject::ckUpdateString(json,"data[0].Start_DateTime","2018-01-27T15:10:00+05:30")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[0].type","lead")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[0].participant","1000000071949")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[1].type","contact")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[1].participant","1000000071957")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[2].type","email")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[2].participant","newcrmapi@zoho.com")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[3].type","user")
    CkJsonObject::ckUpdateString(json,"data[0].Participants[3].participant","1000000030977")
    CkJsonObject::ckUpdateString(json,"data[0].Event_Title","Event_Title")
    CkJsonObject::ckUpdateBool(json,"data[0].send_notification",1)
    CkJsonObject::ckUpdateString(json,"data[0].End_DateTime","2018-01-27T17:10:00+05:30")

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v2/Events","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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



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


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-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

Postman Collection Item JSON

{
  "name": "Events",
  "request": {
    "method": "POST",
    "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",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Events"
      ]
    },
    "description": "To add new entities to a module."
  },
  "response": [
  ]
}