Access & visibility
Allow meetings.UpdateMeeting on your API key. Resource read permissions: core:Meeting. Resource write permissions: core:Meeting.
Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.
Request fields
Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
idstringRequiredID of a visible core:Meeting record. Find it with meetings.ListMeetings. Use the record's top-level id, not a business field or account ID.
dataMeetingOptionalThe fields to set.
Meeting
Meeting basics5 fields
titlestringOptionalMeeting title. May be absent when no title has been supplied.
start_timenumberOptionalMeeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field.
end_timenumberOptionalMeeting end time in Unix milliseconds. May be absent before the meeting ends.
languagestringOptionalLanguage recorded for the meeting, such as en or no. It may differ from summary_language.
meeting_typestringOptionalDescriptive meeting category in the meeting's language. Free text, not a fixed enum.
Participants and visibility1 fields
participantsarray of string or MeetingParticipantOptionalAttendee names or objects containing a name, email and optional Person record reference.
Item fields
MeetingParticipant
namestringOptionalDisplay name.
emailstringOptionalEmail address.
refstringOptionalPerson record ID for this attendee, when matched to a customer contact. It is not a workspace account ID.
Related records3 fields
contact_refsarray of stringOptionalLinked Person record IDs. Use has to filter for a particular contact.
company_refsarray of stringOptionalLinked Company record IDs. Use has to filter for a particular company.
Agenda1 fields
agendaarray of objectOptionalTwo-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
subtopicsarray of objectOptionalSecond-level discussion topics; no deeper nesting is supported.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
unsetarray of stringOptionalKeys of data to remove.
Each item: "title", "started_by", "start_time", "end_time", "status", "language", "participants", "calendar_event_id", "sharing_external", "call_direction", "call_outcome", "call_duration_ms", "counterpart_e164", "call_forwarded", "conference_url", "contact_refs", "company_refs", "related_meetings", "agenda", "meeting_type", "gist", "summary_bullets", "summary", "summary_language", "custom_summary".
expectedobjectOptionalPrior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.
Nested fields
titlestring or objectOptionalCommit only if the previous title value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
started_bystring or objectOptionalCommit only if the previous started_by value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
start_timenumber or objectOptionalCommit only if the previous start_time value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
end_timenumber or objectOptionalCommit only if the previous end_time value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
statusstring or objectOptionalCommit only if the previous status value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
languagestring or objectOptionalCommit only if the previous language value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
participantsarray of string or MeetingParticipant or objectOptionalCommit only if the previous participants value matches; use $absent to require that this field is missing.
Nested fields
Variant 1
MeetingParticipant
namestringOptionalDisplay name.
emailstringOptionalEmail address.
refstringOptionalPerson record ID for this attendee, when matched to a customer contact. It is not a workspace account ID.
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
calendar_event_idstring or objectOptionalCommit only if the previous calendar_event_id value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
sharing_externalboolean or objectOptionalCommit only if the previous sharing_external value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
call_directionstring or objectOptionalCommit only if the previous call_direction value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
call_outcomestring or objectOptionalCommit only if the previous call_outcome value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
call_duration_msnumber or objectOptionalCommit only if the previous call_duration_ms value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
counterpart_e164string or objectOptionalCommit only if the previous counterpart_e164 value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
call_forwardedboolean or objectOptionalCommit only if the previous call_forwarded value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
conference_urlstring or objectOptionalCommit only if the previous conference_url value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
contact_refsarray of string or objectOptionalCommit only if the previous contact_refs value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
company_refsarray of string or objectOptionalCommit only if the previous company_refs value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
agendaarray of object or objectOptionalCommit only if the previous agenda value matches; use $absent to require that this field is missing.
Nested fields
Variant 1
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
subtopicsarray of objectOptionalSecond-level discussion topics; no deeper nesting is supported.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
meeting_typestring or objectOptionalCommit only if the previous meeting_type value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
giststring or objectOptionalCommit only if the previous gist value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
summary_bulletsarray of string or objectOptionalCommit only if the previous summary_bullets value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
summarystring or objectOptionalCommit only if the previous summary value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
summary_languagestring or objectOptionalCommit only if the previous summary_language value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
custom_summaryobject (2 variants)OptionalCommit only if the previous custom_summary value matches; use $absent to require that this field is missing.
Nested fields
Variant 1
examplestringOptionalExample output illustrating the desired summary style.
instructionsstringOptionalInstructions to follow when generating the summary.
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
Update without losing changes
Send only the business fields you want to change in data; omitted fields stay unchanged. Use unset to remove an optional field. Setting a field to null is a different action and is allowed only when its schema permits null.
Use expected for a conditional update: supply the values you last read for the fields whose concurrent changes would matter. {"$absent": true} expects a missing field. A conflict means you must read the record again and decide how to reconcile the change. Keep the same idempotency key when retrying the original action; use a new key for a revised action.
Response
Returns 200 OK with a JSON body.
Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.
An ended meeting is not necessarily summarized yet. Summary fields can be absent while work is pending or when no summary is available; this response does not expose the reason.
Transcript text and recording URLs are not part of this model. Personal notes are a separate resource and retain the acting member's access rules.
itemMeetingRecordRequiredThe requested record, including its metadata and data fields.
MeetingRecord
idstringRequiredStable core:Meeting record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.
created_atnumberRequiredTime the record was created, in Unix milliseconds.
updated_atnumberRequiredTime the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.
created_bystring or nullRequiredAccount that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.
privatebooleanRequiredTrue for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.
dataMeetingRequiredThe record's fields.
Meeting
Meeting basics6 fields
titlestringOptionalMeeting title. May be absent when no title has been supplied.
start_timenumberRequiredMeeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field.
end_timenumberOptionalMeeting end time in Unix milliseconds. May be absent before the meeting ends.
statusstringRequiredMeeting lifecycle state, including live, paused and ended. This is an open string, not a closed enum; tolerate additional states.
languagestringOptionalLanguage recorded for the meeting, such as en or no. It may differ from summary_language.
meeting_typestringOptionalDescriptive meeting category in the meeting's language. Free text, not a fixed enum.
Participants and visibility3 fields
started_bystringOptionalHost account ID. This is the member identity that owns the meeting; created_by is separate record provenance.
participantsarray of string or MeetingParticipantOptionalAttendee names or objects containing a name, email and optional Person record reference.
Item fields
MeetingParticipant
namestringOptionalDisplay name.
emailstringOptionalEmail address.
refstringOptionalPerson record ID for this attendee, when matched to a customer contact. It is not a workspace account ID.
sharing_externalbooleanOptionalWhether external attendees were identified when the meeting was prepared. This is not permission to share the meeting externally; absence means this fact was not recorded.
Summary5 fields
giststringOptionalOne- or two-line takeaway from the meeting.
summary_bulletsarray of stringOptionalKey points extracted from the meeting.
summarystringOptionalFull meeting summary formatted as Markdown.
summary_languagestringOptionalLanguage of the generated summary, such as en or no.
custom_summaryobjectOptionalInstructions and optional example used to generate a custom summary. This is configuration, not the generated summary.
Nested fields
examplestringOptionalExample output illustrating the desired summary style.
instructionsstringOptionalInstructions to follow when generating the summary.
Related records5 fields
calendar_event_idstringOptionalID of a core:CalendarEvent record. Find it with meetings.ListCalendarEvents and use the top-level id. This is not an account ID or a display name.
conference_urlstringOptionalConference link from the calendar invitation, when one is available.
contact_refsarray of stringOptionalLinked Person record IDs. Use has to filter for a particular contact.
company_refsarray of stringOptionalLinked Company record IDs. Use has to filter for a particular company.
Agenda1 fields
agendaarray of objectOptionalTwo-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
subtopicsarray of objectOptionalSecond-level discussion topics; no deeper nesting is supported.
Item fields
idstringOptionalStable identifier of this agenda topic or subtopic.
namestringOptionalTopic or subtopic title.
statusstringOptionalTopic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.
Allowed: "None", "Touched", "Partial", "Full".
Phone calls5 fields
call_directionstringOptionalPhone call direction, currently inbound or outbound. Absent for meetings without phone-call metadata.
call_outcomestringOptionalHow a phone call ended, including completed, no_answer, busy, declined, canceled or failed. This is an open string.
call_duration_msnumberOptionalRecorded phone-call duration in milliseconds.
counterpart_e164stringOptionalOther party's phone number in international E.164 format, such as +4721001234.
call_forwardedbooleanOptionalWhether the incoming call was forwarded from another phone number.
Errors & retries
Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.
For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.
| HTTP status | Code | What to do |
|---|---|---|
| 400 | invalid_json |
Send a JSON object with Content-Type: application/json. |
| 400 | invalid_input |
Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | invalid_key |
The workspace API key is missing, invalid or revoked. |
| 403 | forbidden |
Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | not_found |
The requested operation or resource is not available to this credential. |
| 429 | rate_limited |
Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |
| 409 | conflict |
A supplied expected value no longer matches. Read the record again before deciding whether to retry. |
Next steps
JSON schemas
Use the complete schemas for validation or client generation.
Full request JSON schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of a visible `core:Meeting` record. Find it with [meetings.ListMeetings](/reference/meetings/ListMeetings). Use the record's top-level `id`, not a business field or account ID."
},
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Meeting title. May be absent when no title has been supplied."
},
"start_time": {
"type": "number",
"description": "Meeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field."
},
"end_time": {
"type": "number",
"description": "Meeting end time in Unix milliseconds. May be absent before the meeting ends."
},
"language": {
"type": "string",
"description": "Language recorded for the meeting, such as en or no. It may differ from summary_language."
},
"participants": {
"type": "array",
"items": {
"title": "MeetingParticipant",
"anyOf": [
{
"type": "string",
"title": "MeetingParticipant"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name."
},
"email": {
"type": "string",
"description": "Email address."
},
"ref": {
"type": "string",
"description": "Person record ID for this attendee, when matched to a customer contact. It is not a workspace account ID."
}
},
"required": [],
"additionalProperties": false,
"title": "MeetingParticipant"
}
]
},
"description": "Attendee names or objects containing a name, email and optional Person record reference."
},
"contact_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Person"
},
"description": "Linked Person record IDs. Use has to filter for a particular contact."
},
"company_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Company"
},
"description": "Linked Company record IDs. Use has to filter for a particular company."
},
"related_meetings": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Meeting"
},
"description": "IDs of related Meeting records. Each related record has its own access rules."
},
"agenda": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
},
"subtopics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
}
},
"additionalProperties": false
},
"description": "Second-level discussion topics; no deeper nesting is supported."
}
},
"additionalProperties": false
},
"description": "Two-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered."
},
"meeting_type": {
"type": "string",
"description": "Descriptive meeting category in the meeting's language. Free text, not a fixed enum."
}
},
"required": [],
"additionalProperties": false,
"description": "The fields to set.",
"title": "Meeting"
},
"unset": {
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"started_by",
"start_time",
"end_time",
"status",
"language",
"participants",
"calendar_event_id",
"sharing_external",
"call_direction",
"call_outcome",
"call_duration_ms",
"counterpart_e164",
"call_forwarded",
"conference_url",
"contact_refs",
"company_refs",
"related_meetings",
"agenda",
"meeting_type",
"gist",
"summary_bullets",
"summary",
"summary_language",
"custom_summary"
]
},
"description": "Keys of `data` to remove."
},
"expected": {
"type": "object",
"description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
"additionalProperties": false,
"properties": {
"title": {
"description": "Commit only if the previous title value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Meeting title. May be absent when no title has been supplied."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"started_by": {
"description": "Commit only if the previous started_by value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Host account ID. This is the member identity that owns the meeting; created_by is separate record provenance."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"start_time": {
"description": "Commit only if the previous start_time value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "number",
"description": "Meeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"end_time": {
"description": "Commit only if the previous end_time value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "number",
"description": "Meeting end time in Unix milliseconds. May be absent before the meeting ends."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"status": {
"description": "Commit only if the previous status value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Meeting lifecycle state, including live, paused and ended. This is an open string, not a closed enum; tolerate additional states."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"language": {
"description": "Commit only if the previous language value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Language recorded for the meeting, such as en or no. It may differ from summary_language."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"participants": {
"description": "Commit only if the previous participants value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"title": "MeetingParticipant",
"anyOf": [
{
"type": "string",
"title": "MeetingParticipant"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name."
},
"email": {
"type": "string",
"description": "Email address."
},
"ref": {
"type": "string",
"description": "Person record ID for this attendee, when matched to a customer contact. It is not a workspace account ID."
}
},
"required": [],
"additionalProperties": false,
"title": "MeetingParticipant"
}
]
},
"description": "Attendee names or objects containing a name, email and optional Person record reference."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"calendar_event_id": {
"description": "Commit only if the previous calendar_event_id value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "ID of a `core:CalendarEvent` record. Find it with [meetings.ListCalendarEvents](/reference/meetings/ListCalendarEvents) and use the top-level `id`. This is not an account ID or a display name."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"sharing_external": {
"description": "Commit only if the previous sharing_external value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "boolean",
"description": "Whether external attendees were identified when the meeting was prepared. This is not permission to share the meeting externally; absence means this fact was not recorded."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"call_direction": {
"description": "Commit only if the previous call_direction value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Phone call direction, currently inbound or outbound. Absent for meetings without phone-call metadata."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"call_outcome": {
"description": "Commit only if the previous call_outcome value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "How a phone call ended, including completed, no_answer, busy, declined, canceled or failed. This is an open string."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"call_duration_ms": {
"description": "Commit only if the previous call_duration_ms value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "number",
"description": "Recorded phone-call duration in milliseconds."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"counterpart_e164": {
"description": "Commit only if the previous counterpart_e164 value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Other party's phone number in international E.164 format, such as +4721001234."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"call_forwarded": {
"description": "Commit only if the previous call_forwarded value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "boolean",
"description": "Whether the incoming call was forwarded from another phone number."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"conference_url": {
"description": "Commit only if the previous conference_url value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Conference link from the calendar invitation, when one is available."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"contact_refs": {
"description": "Commit only if the previous contact_refs value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Person"
},
"description": "Linked Person record IDs. Use has to filter for a particular contact."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"company_refs": {
"description": "Commit only if the previous company_refs value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Company"
},
"description": "Linked Company record IDs. Use has to filter for a particular company."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"related_meetings": {
"description": "Commit only if the previous related_meetings value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Meeting"
},
"description": "IDs of related Meeting records. Each related record has its own access rules."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"agenda": {
"description": "Commit only if the previous agenda value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
},
"subtopics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
}
},
"additionalProperties": false
},
"description": "Second-level discussion topics; no deeper nesting is supported."
}
},
"additionalProperties": false
},
"description": "Two-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"meeting_type": {
"description": "Commit only if the previous meeting_type value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Descriptive meeting category in the meeting's language. Free text, not a fixed enum."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"gist": {
"description": "Commit only if the previous gist value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "One- or two-line takeaway from the meeting."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"summary_bullets": {
"description": "Commit only if the previous summary_bullets value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"description": "Key points extracted from the meeting."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"summary": {
"description": "Commit only if the previous summary value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Full meeting summary formatted as Markdown."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"summary_language": {
"description": "Commit only if the previous summary_language value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Language of the generated summary, such as en or no."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"custom_summary": {
"description": "Commit only if the previous custom_summary value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "object",
"properties": {
"example": {
"type": "string",
"description": "Example output illustrating the desired summary style."
},
"instructions": {
"type": "string",
"description": "Instructions to follow when generating the summary."
}
},
"additionalProperties": false,
"description": "Instructions and optional example used to generate a custom summary. This is configuration, not the generated summary."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
}
}
}
},
"required": [
"id"
],
"additionalProperties": false,
"examples": [
{
"id": "e_meeting_example",
"data": {
"title": "Northstar · pilot kickoff"
}
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable core:Meeting record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
},
"created_at": {
"type": "number",
"description": "Time the record was created, in Unix milliseconds."
},
"updated_at": {
"type": "number",
"description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
},
"created_by": {
"type": [
"string",
"null"
],
"description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
},
"private": {
"type": "boolean",
"description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
},
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Meeting title. May be absent when no title has been supplied."
},
"started_by": {
"type": "string",
"description": "Host account ID. This is the member identity that owns the meeting; created_by is separate record provenance."
},
"start_time": {
"type": "number",
"description": "Meeting start time in Unix milliseconds. Use a number, not an ISO date string, when filtering this field."
},
"end_time": {
"type": "number",
"description": "Meeting end time in Unix milliseconds. May be absent before the meeting ends."
},
"status": {
"type": "string",
"description": "Meeting lifecycle state, including live, paused and ended. This is an open string, not a closed enum; tolerate additional states."
},
"language": {
"type": "string",
"description": "Language recorded for the meeting, such as en or no. It may differ from summary_language."
},
"participants": {
"type": "array",
"items": {
"title": "MeetingParticipant",
"anyOf": [
{
"type": "string",
"title": "MeetingParticipant"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name."
},
"email": {
"type": "string",
"description": "Email address."
},
"ref": {
"type": "string",
"description": "Person record ID for this attendee, when matched to a customer contact. It is not a workspace account ID."
}
},
"required": [],
"additionalProperties": false,
"title": "MeetingParticipant"
}
]
},
"description": "Attendee names or objects containing a name, email and optional Person record reference."
},
"calendar_event_id": {
"type": "string",
"description": "ID of a `core:CalendarEvent` record. Find it with [meetings.ListCalendarEvents](/reference/meetings/ListCalendarEvents) and use the top-level `id`. This is not an account ID or a display name."
},
"sharing_external": {
"type": "boolean",
"description": "Whether external attendees were identified when the meeting was prepared. This is not permission to share the meeting externally; absence means this fact was not recorded."
},
"call_direction": {
"type": "string",
"description": "Phone call direction, currently inbound or outbound. Absent for meetings without phone-call metadata."
},
"call_outcome": {
"type": "string",
"description": "How a phone call ended, including completed, no_answer, busy, declined, canceled or failed. This is an open string."
},
"call_duration_ms": {
"type": "number",
"description": "Recorded phone-call duration in milliseconds."
},
"counterpart_e164": {
"type": "string",
"description": "Other party's phone number in international E.164 format, such as +4721001234."
},
"call_forwarded": {
"type": "boolean",
"description": "Whether the incoming call was forwarded from another phone number."
},
"conference_url": {
"type": "string",
"description": "Conference link from the calendar invitation, when one is available."
},
"contact_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Person"
},
"description": "Linked Person record IDs. Use has to filter for a particular contact."
},
"company_refs": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Company"
},
"description": "Linked Company record IDs. Use has to filter for a particular company."
},
"related_meetings": {
"type": "array",
"items": {
"type": "string",
"description": "id of a core:Meeting"
},
"description": "IDs of related Meeting records. Each related record has its own access rules."
},
"agenda": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
},
"subtopics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier of this agenda topic or subtopic."
},
"name": {
"type": "string",
"description": "Topic or subtopic title."
},
"status": {
"type": "string",
"enum": [
"None",
"Touched",
"Partial",
"Full"
],
"description": "Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive."
}
},
"additionalProperties": false
},
"description": "Second-level discussion topics; no deeper nesting is supported."
}
},
"additionalProperties": false
},
"description": "Two-level agenda: topics and optional subtopics. Status tracks how much of each topic was covered."
},
"meeting_type": {
"type": "string",
"description": "Descriptive meeting category in the meeting's language. Free text, not a fixed enum."
},
"gist": {
"type": "string",
"description": "One- or two-line takeaway from the meeting."
},
"summary_bullets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Key points extracted from the meeting."
},
"summary": {
"type": "string",
"description": "Full meeting summary formatted as Markdown."
},
"summary_language": {
"type": "string",
"description": "Language of the generated summary, such as en or no."
},
"custom_summary": {
"type": "object",
"properties": {
"example": {
"type": "string",
"description": "Example output illustrating the desired summary style."
},
"instructions": {
"type": "string",
"description": "Instructions to follow when generating the summary."
}
},
"additionalProperties": false,
"description": "Instructions and optional example used to generate a custom summary. This is configuration, not the generated summary."
}
},
"required": [
"start_time",
"status"
],
"additionalProperties": false,
"description": "The record's fields.",
"title": "Meeting"
}
},
"required": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data"
],
"additionalProperties": false,
"description": "The requested record, including its metadata and data fields.",
"title": "MeetingRecord"
}
},
"required": [
"item"
],
"additionalProperties": false,
"examples": [
{
"item": {
"id": "e_meeting_example",
"created_at": 1791276900000,
"updated_at": 1791280800000,
"created_by": "a_jamie",
"private": false,
"data": {
"title": "Northstar · pilot kickoff",
"start_time": 1791277200000,
"end_time": 1791279900000,
"status": "ended",
"started_by": "a_jamie",
"participants": [
{
"name": "Jamie Lee",
"email": "jamie@example.com"
},
{
"name": "Alex Morgan",
"email": "alex@example.org",
"ref": "e_person_alex"
}
],
"company_refs": [
"e_company_northstar"
],
"gist": "The team agreed to begin the pilot on 19 October.",
"summary_bullets": [
"Alex will send the source data by Friday.",
"Jamie will prepare the pilot workspace."
],
"summary": "## Decisions\nStart the pilot on 19 October.\n\n## Next steps\n- Alex: send source data by Friday.\n- Jamie: prepare the workspace.",
"summary_language": "en"
}
}
}
]
}