Events
Manages calendar-based records such as meetings or scheduled events, with full create, update, and delete support.
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 | True |
Unique identifier for the event record. |
| Title | String | False |
Title or subject of the event. |
| Location | String | False |
Location where the event is scheduled to take place. |
| Allday | Bool | False |
Indicates whether the event spans the entire day. |
| From | Datetime | False |
Start date and time of the event. |
| To | Datetime | False |
End date and time of the event. |
| Host_Id | String | False |
Identifier of the user hosting the event. |
| Host_FirstName | String | True |
First name of the event host. |
| Host_LastName | String | True |
Last name of the event host. |
| Host_Email | String | True |
Email address of the event host. |
| Host_Name | String | True |
Full name of the event host. |
| ContactName_Id | String | False |
Identifier of the contact associated with the event. |
| ContactName_Name | String | True |
Name of the contact associated with the event. |
| RelatedTo_Id | String | False |
Identifier of the related record, such as a deal or account. |
| RelatedTo_Name | String | True |
Name of the related record linked to the event. |
| Repeat_Id | String | False |
Identifier of the recurrence rule, if the event is recurring. |
| Repeat_Name | String | True |
Name or description of the recurrence rule. |
| Reminder | String | False |
Reminder setting for the event, such as a notification before the start time. |
| CreatedBy_Id | String | False |
Identifier of the user who created the event record. |
| CreatedBy_FirstName | String | True |
First name of the user who created the event record. |
| CreatedBy_LastName | String | True |
Last name of the user who created the event record. |
| CreatedBy_Email | String | True |
Email address of the user who created the event record. |
| CreatedBy_Name | String | True |
Full name of the user who created the event record. |
| ModifiedBy_Id | String | False |
Identifier of the user who last modified the event record. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the event record. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the event record. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the event record. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the event record. |
| CreatedTime | Datetime | False |
Timestamp indicating when the event record was created. |
| ModifiedTime | Datetime | False |
Timestamp indicating when the event record was last modified. |
| Participants | String | False |
Comma-separated list of participants involved in the event. |
| Description | String | False |
Detailed description or notes related to the event. |
| Check-InTime | Datetime | True |
Timestamp when the user checked in for the event. |
| Check-InBy_Id | String | False |
Identifier of the user who performed the check-in. |
| Check-InBy_Name | String | True |
Full name of the user who performed the check-in. |
| Check-InComment | String | True |
Comment provided at the time of check-in. |
| Check-InSub-Locality | String | True |
Sub-locality information captured during check-in. |
| Check-InCity | String | True |
City where the check-in occurred. |
| Check-InState | String | True |
State or region of the check-in location. |
| Check-InCountry | String | True |
Country where the check-in took place. |
| Latitude | Double | True |
Latitude coordinate of the check-in location. |
| Longitude | Double | True |
Longitude coordinate of the check-in location. |
| ZipCode | String | True |
ZIP or postal code of the check-in location. |
| Check-InAddress | String | True |
Full address captured during check-in. |
| CheckedInStatus | String | True |
Status indicating whether the participant has checked in. |
| Tag | String | False |
Comma-separated list of tags associated with the event. |
| LastActivityTime | Datetime | False |
Timestamp of the most recent activity related to the event. |
| ModuleName | String | False |
Name of the module where the event record is stored. |
Pseudo-Columns
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| DuplicateCheckFields | String |
Field or fields used to identify duplicate records during an upsert. Multiple fields are supported in the REST API, but only one is allowed in the BULK API. |
| Trigger | String |
Specifies whether to trigger automation or workflow rules when inserting the record. |
| CustomViewId | Long |
Identifier of the custom view used to filter this record. Applies only when the useCOQL parameter is set to false. |