Events
Response Structure
{
"data": [
{
"All_day": false, //Represents if the event takes place all day.
"Owner": { //Name, ID, and email of the owner of the event
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Check_In_State": null, //Check in details of the participants of the event
"$currency_symbol": "DA", //The supported currency in which the revenue is generated
"Latitude": null, //The geographical details of the event location
"Participants": [ //Contains the ID and type of each participant in individual JSON objects. Possible participant types are "lead", "contact", "user", and "email".
{
"Email": "abc.123@xyz.com", //Email ID of the participant
"name": "Paul Daly", //Name of the participant
"invited": false, //Represents whether the participant is invited to the event
"id": "4150868000002792037", //Unique Id of the participant of the event
"type": "lead", //Represents if the participant is a contact or lead
"participant": "4150868000002748005", //Unique Id of the contact or lead
"status": "not_known" //Represents if the participant accepted the event invitation
}
],
"$process_flow": false, //Represents if the record is a blueprint data
"Exchange_Rate": 3, //Represents the exchange rate of the currency
"Currency": "DZD", //The supported currency in which the revenue is generated
"Check_In_City": null, //The location in which the participants have checked in for the event
"id": "4150868000002792020", //Unique ID of the event
"Check_In_Comment": null, //The comment added by the participant while checking in for the event
"$approved": true, //Represents if the event is approved
"Remind_At": "2020-08-02T15:15:00+05:30", //The date and time in the current user's time zone (in ISO8601 format) at which a reminder is sent to the participants.
"Who_Id": { //The name and ID of the contact that the event is related to; that contact may or may not be a participant of the event.
"name": "Name",
"id": "3652397000000270003"
},
"Check_In_Status": "PLANNED", //Represents the check-in status of the organiser of the event
"$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
},
"Venue": "Online Meeting( Powered by Zoho Meeting )", //The place where the event takes place. Accepts a maximum of 255 characters, alphanumeric, and special characters.
"ZIP_Code": null, //Postal code of the venue
"Created_Time": "2020-08-02T22:13:58+05:30", //Date and time at which the event was created. This is a system-generated field. You cannot modify it.
"$editable": true, //Represents if the user can edit records in the module
"Longitude": null, //The geographical details of the event location
"Check_In_Time": null, //The check in time details of the participants of the event
"Recurring_Activity": { //JSON Object that contains information about the recurrence pattern of the event in the key "RRULE".
"RRULE": "FREQ=DAILY;INTERVAL=1;DTSTART=2019-01-23;UNTIL=-1"
},
"What_Id": { //The name and ID of the Account, Deal, Product, Quote, Invoice, Campaign, Vendor, Case, Purchase Order, or Sales Order that the event is created for.
"name": "Paul Daly",
"id": "4150868000002748005"
},
"Created_By": { //Name, ID, and email of the user who created the event. This is a system-generated field. You cannot modify it.
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Check_In_Address": null, //Check in address details of the participants
"Description": null, //Description about the event, if any
"Start_DateTime": "2020-08-02T15:30:00+05:30", //The date and time (in ISO8601 format) at which the event begins.
"$review_process": null, //Review process details of the event
"Event_Title": "New Meeting", //Title of the event. Accepts a maximum of 255 characters, alphanumeric, and special characters.
"$calendar_booking_event": false, //Represents whether the event was created from CRM calendar
"End_DateTime": "2020-08-02T16:30:00+05:30", //The date and time (in ISO8601 format) at which the event ends.
"Check_In_By": null, //Represents the check in details of the participants
"Modified_By": { //The name and ID of the user who modified the event
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"$review": null, //Review process details of the event
"Check_In_Country": null, //Represents the check in details of the participants
"Modified_Time": "2020-08-02T22:13:58+05:30", //The date and time at which the event was last modified
"$recurrence_id": null, //The unique ID of the recurrence event
"$orchestration": false, //Represents if the record is a part of orchestration process
"$se_module": "Leads", //The API name of the parent module given in the key "What_Id". This key is mandatory when you include the "What_Id".
"Check_In_Sub_Locality": null, //Check in address details of the participants
"$in_merge": false,
"$meeting_details": null,
"$u_id": "4150868000002792020", //Unique ID of the recurring event
"Tag": [], //List of tags associated with the record
"$send_notification": true, //Represents if you want to send invitations to the participants of the event. The value true sends out invitations, and false does not.
"$approval_state": "approved" //Represents if the record is approved
}
]
}
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.
- To know more about the 'RRULE' key, refer to link.