Events
Create, update, delete, and query information regarding events.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO Events (Title, `From`, To) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00')
INSERT INTO Events (Title, `From`, To, ModuleName) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts')
INSERT INTO Events (Title, `From`, To, ModuleName, RelatedTo_Id) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts', '2788704000120533263')
Required fields: Title, From, To, ModuleName if RelatedTo_Id is specified..
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Events WHERE Id = '3152079000000153079'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Events SET Description = 'Changed from the API.' WHERE Id = '3152079000000154219'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
NOTE: This table is supported only in v2.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for this record. |
| Title | String | False |
The title of the event. |
| Location | String | False |
The location of the event. |
| From | Datetime | False |
The starting time of the event. |
| Allday | Bool | False |
Whether the even will be going on for the whole day or not. |
| To | Datetime | False |
The end time of the event. |
| Host_Id | String | False |
The Id of the host of the event. |
| Host_FirstName | String | False |
The First Name of the host of the event. |
| Host_LastName | String | False |
The Last Name of the host of the event. |
| ContactName_Id | String | False |
The Id of the contact of the event. |
| CreatedBy_Id | String | False |
The Id of the User who created the record. |
| ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
| ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
| ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
| Description | String | False |
The description of the event. |
| RelatedTo_Id | String | False |
The Id to whom this event is related to. |
| Repeat | String | False |
Whether this is a recurring activity or not. |
| CreatedTime | Datetime | False |
The time when the record was created. |
| ModifiedTime | Datetime | False |
The time when the record was modified. |
| Check_InTime | Datetime | True |
The time of the check in for this event. |
| Check_InBy_Id | String | False |
The Id of the person who checked in for this event. |
| Check_InComment | String | True |
The check in comment for this event. |
| Check_InSub_Locality | String | True |
The sub locality of the check in for this event. |
| Reminder | String | False |
A reminder set for this event. |
| Check_InCity | String | True |
The city where the check in for this event will be held at. |
| Check_InState | String | True |
The state where the check in for this event will be held at. |
| Check_InCountry | String | True |
The country where the check in for this event will be held at. |
| Latitude | String | True |
The latitude of where the event will take place. |
| Longitude | String | True |
The longitude of where the event will take place. |
| ZipCode | String | True |
The ZIP code of where the event will take place. |
| Check_InAddress | String | True |
The address of the check in for this event. |
| CheckedInStatus | String | True |
The check in status for this event. |
| Tag | String | False |
A list of tags for this event. |
| ModuleName | String | False |
The name of the module this event belongs to. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Word | String |
Used to search for a specific word in records. |
| DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
| Converted | Boolean |
Set to true to return only converted records. |
| Approved | Boolean |
Set to true to return only approved records. |
| CustomViewId | String |
The custom view Id to be used for filtering this record. |