Access & visibility
Allow meetings.DeleteMeeting 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.
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.
Remove a meeting record
Select the meeting from List meetings and read it before deletion. This removes the Brigg meeting record from live results. It does not cancel the calendar invitation, cancel a booking, notify attendees or stop a running recording. Finish a live meeting in Brigg first.
This is a soft deletion of the meeting record. The standard meeting relationships preserve a deleted-record marker, so this operation does not promise removal of transcript batches, notes or findings. cascaded reports only dependent record IDs actually removed under the current relationship rules and caller's scope. An empty array is expected when no dependents were removed. It is not a receipt that recordings, exports, previously delivered summaries or colleagues' private data were erased. There is no public restore operation. To cancel an appointment, use Cancel booking or Delete calendar event as appropriate.
Deletion and retries
A successful response reports whether this call removed the record or it was already absent. Check cascaded for dependent record IDs returned by the operation. Retrying the same action uses the original idempotency key. A successful deletion is not an archive you can restore through this operation.
To avoid deleting a record someone has changed, read it first and put the relevant prior business values in expected. Keys are relative to data, not prefixed with data.. Use {"$absent": true} to require a missing field. A mismatch returns 409 conflict; read again and decide whether deletion is still appropriate. A revised action needs a new idempotency key.
Response
Returns 200 OK with a JSON body.
deletedstringRequireddeleted when this request removed the record; already_deleted when it was already absent.
Allowed: "deleted", "already_deleted".
cascadedarray of stringOptionalIDs of dependent records removed by this deletion. Empty means none were cascaded under this caller's scope; it does not certify deletion of every related artifact or another member's private data.
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."
},
"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"
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"deleted": {
"type": "string",
"enum": [
"deleted",
"already_deleted"
],
"description": "deleted when this request removed the record; already_deleted when it was already absent."
},
"cascaded": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of dependent records removed by this deletion. Empty means none were cascaded under this caller's scope; it does not certify deletion of every related artifact or another member's private data."
}
},
"required": [
"deleted"
],
"additionalProperties": false,
"examples": [
{
"deleted": "deleted"
}
]
}