Skip to content

Activity.md

Latest commit

 

History

History
59 lines (56 loc) · 40.7 KB

Activity.md

File metadata and controls

59 lines (56 loc) · 40.7 KB

Activity

Fields

Field Type Required Description Example
id ?string ➖ The unique identifier of the activity 12345
downstreamId ?string ➖ The third-party API ID of original entity 12345
activityDatetime ?string ➖ The date and time of the activity 2021-05-01T12:00:00.000Z
durationSeconds ?int ➖ The duration of the activity in seconds 1800
userId ?string ➖ The user related to the activity 12345
accountId ?string ➖ The account related to the activity 12345
contactId ?string ➖ The contact related to the activity 12345
companyId ?string ➖ The company related to the activity 12345
opportunityId ?string ➖ The opportunity related to the activity 12345
leadId ?string ➖ The lead related to the activity 12345
ownerId ?string ➖ The owner of the activity 12345
campaignId ?string ➖ The campaign related to the activity 12345
caseId ?string ➖ The case related to the activity 12345
assetId ?string ➖ The asset related to the activity 12345
contractId ?string ➖ The contract related to the activity 12345
productId ?string ➖ The product related to the activity 12345
solutionId ?string ➖ The solution related to the activity 12345
customObjectId ?string ➖ The custom object related to the activity 12345
type Components\ActivityType ✔️ The type of the activity meeting
title ?string ➖ The title of the activity Meeting
description ?string ➖ A description of the activity More info about the meeting
note ?string ➖ An internal note about the activity An internal note about the meeting
location ?string ➖ The location of the activity Space
locationAddress ?Components\Address ➖ N/A
allDayEvent ?bool ➖ Whether the Activity is an all day event or not false
private ?bool ➖ Whether the Activity is private or not true
groupEvent ?bool ➖ Whether the Activity is a group event or not true
eventSubType ?string ➖ The sub type of the group event debrief
groupEventType ?string ➖ The type of the group event Proposed
child ?bool ➖ Whether the activity is a child of another activity or not false
archived ?bool ➖ Whether the activity is archived or not false
deleted ?bool ➖ Whether the activity is deleted or not false
showAs ?Components\ShowAs ➖ N/A busy
done ?bool ➖ Whether the Activity is done or not false
startDatetime ?string ➖ The start date and time of the activity 2021-05-01T12:00:00.000Z
endDatetime ?string ➖ The end date and time of the activity 2021-05-01T12:30:00.000Z
durationMinutes ?int ➖ The duration of the activity in minutes 30
activityDate ?string ➖ The date of the activity 2021-05-01
endDate ?string ➖ The end date of the activity 2021-05-01
recurrent ?bool ➖ Whether the activity is recurrent or not false
reminderDatetime ?string ➖ The date and time of the reminder 2021-05-01T17:00:00.000Z
reminderSet ?bool ➖ Whether the reminder is set or not false
videoConferenceUrl ?string ➖ The URL of the video conference https://meet.example.com/j/88120759396
videoConferenceId ?string ➖ The ID of the video conference zoom:88120759396
customFields array<Components\CustomField1|Components\CustomField2> ➖ Custom fields of the activity
attendees array<Components\ActivityAttendee> ➖ N/A
customMappings array<string, mixed> ➖ When custom mappings are configured on the resource, the result is included here.
updatedBy ?string ➖ The user who last updated the activity 12345
createdBy ?string ➖ The user who created the activity 12345
updatedAt ?string ➖ The date and time when the activity was last updated 2020-09-30T07:43:32.000Z
createdAt ?string ➖ The date and time when the activity was created 2020-09-30T07:43:32.000Z
passThrough array<Components\PassThroughBody> ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.