Events

Response Structure


{
"data": [
{
"All_day": true, //Represents whether it is an all-day event
"Owner": { //Name and ID of the owner of the event
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Check_In_State": null,
"Check_In_Address": null,
"Description": null, //Description of the event
"$currency_symbol": "Rs.", //The supported currency in which the revenue is generated
"Start_DateTime": "2020-01-23T00:00:00+00:00", //The date an time at which the event starts. This is a mandatory field
"Latitude": null,
"Participants": [ //List of participants in the event and their details
{ //Participant 1
"Email": "abc.123@xyz.com", //Email ID of the participant
"name": "Name", //Name of the participant
"invited": true, //Represents whether the participant is invited to the event
"id": "3652397000000458396", //Unique Id of the participant of the event
"type": "contact", //Represents if the participant is a contact or lead
"participant": "3652397000000270003", //Unique Id of the contact or lead
"status": "not_known" //Represents if the participant accepted the event invitation
},
{ //Participant 2
"Email": "anotheremail@xyz.com",
"name": "Name1",
"invited": true,
"id": "3652397000000458398",
"type": "contact",
"participant": "3652397000000269077",
"status": "not_known"
}
],
"Event_Title": "event 3", //Title of the event. This is a mandatory field
"$calendar_booking_event": false, //Represents whether the event was created from CRM calendar
"End_DateTime": "2020-01-23T23:59:59+00:00", //The date and time at which the event ends
"Check_In_By": null,
"Modified_By": { //The name and ID of the user who modified the event
"name": "Patricia Boyle S",
"id": "3652397000000186017"
},
"$process_flow": false, //Represents if the record is a blueprint data
"Check_In_City": null,
"id": "3652397000000454733", //Unique ID of the event
"Check_In_Comment": null,
"$approved": true, //Represents if the event is approved
"Remind_At": "2020-01-22T08:00:00+05:30", //The date and time at which the system sends a reminder of the event
"Who_Id": { //Name and ID of the contact for whom the event is organized
"name": "Name",
"id": "3652397000000270003"
},
"Check_In_Status": "PLANNED", //Represents the check-in status of the organiser of the event
"Check_In_Country": null,
"$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
"delegate": false,
"approve": false,
"reject": false,
"resubmit": false
},
"Modified_Time": "2019-01-23T09:35:29+05:30", //Date and time at which the event was last modified
"Venue": "Venue", //The venue where the event takes place
"ZIP_Code": null, //Postal code of the venue
"Created_Time": "2019-01-23T09:35:29+05:30", //Date and time at which the event was created. This is a system-generated field. You cannot modify it.
"$editable": true, //Represents whether this record is editable
"$recurrence_id": "1579737600000", //Unique ID for recurrence
"Longitude": null,
"Check_In_Time": null,
"$se_module": "Accounts", //Represents the module the event is related to
"Recurring_Activity": { //Details about the recurrence frequency, recurrence interval, the date at which the recurrence starts, and the date until which the event recurs
"RRULE": "FREQ=DAILY;INTERVAL=1;DTSTART=2019-01-23;UNTIL=-1"
},
"What_Id": { //Name and ID of the Account the event is associated with
"name": "Account_namer",
"id": "3652397000000261026"
},
"Check_In_Sub_Locality": null,
"$u_id": "3652397000000454002", //Unique ID of the recurring event
"Created_By": { //name and ID of the user who created the event. This is a system-generated field. You cannot modify it.
"name": "Patricia Boyle S",
"id": "3652397000000186017"
},
"Tag": [], //List of tags associated with the record
"$send_notification": true //Represents whether a notification is sent to the event participants
}
]
}

Note:


  • The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
  • For more information about sample attributes, refer Get List of Records.