Skip to main content

ScheduleMeeting

Stored in the schedulemeetings collection. createdAt and updatedAt are maintained automatically.

Returned by GET /meeting, POST /meeting, GET /meeting/:id.

FieldTypeNotes
companyObjectId -> Company
createdByObjectId -> Member
updatedByObjectId -> Member
hostObjectId -> Member
titlestringrequired
descriptionstring
providerstringrequired · default offline · one of zoom, google meet, offline
appRefstringone of ZoomAccount, GoogleCalendarAccount, OfflineLocation
appObjectId
appSnapshot.namestring
appSnapshot.emailstring
appSnapshot.addressstring
appSnapshot.linkstring
meetingLinkstring
passcodestring
contactObjectId -> Contact
leadObjectId -> Lead
attendeesobject[]default []
attendees.memberObjectId -> Member
attendees.contactObjectId -> Contact
attendees.namestring
attendees.emailstring
attendees.responseStatusstringdefault needsAction · one of needsAction, accepted, declined, tentative
startTimedaterequired
endTimedate
durationnumber
timezonestring
recurrence.enabledbooleandefault false
recurrence.frequencystringone of daily, weekly, monthly
recurrence.intervalnumber
recurrence.byWeekDaysnumber[]default []
recurrence.endDatedate
recurrence.countnumber
remindersobject[]default []
reminders.minutesBeforenumber
reminders.sentbooleandefault false
reminders._idObjectIddefault "6a95712f932657988a91c0d0"
statusstringdefault scheduled · one of scheduled, started, completed, cancelled, rescheduled
metadataany
_idObjectIddefault "6a95712f932657988a91c0d1"
createdAtdateset once
updatedAtdate