Access & visibility
Allow meetings.UpdateMeetingTemplate on your API key. Resource read permissions: core:MeetingTemplate. Resource write permissions: core:MeetingTemplate.
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:MeetingTemplate record. Find it with meetings.ListMeetingTemplates. Use the record's top-level id, not a business field or account ID.
dataMeetingTemplateOptionalThe fields to set.
MeetingTemplate
Template3 fields
namestringOptionalName used to select this meeting template.
tagsarray of stringOptionalStable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.
sort_ordernumberOptionalRelative ordering value used to display templates.
Content2 fields
agendaarray of objectOptionalDefault two-level agenda to use when applying this template.
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".
custom_summaryobjectOptionalInstructions and optional example for generating summaries from meetings using this template.
Nested fields
examplestringOptionalExample output illustrating the desired summary style.
instructionsstringOptionalInstructions to follow when generating the summary.
unsetarray of stringOptionalKeys of data to remove.
Each item: "name", "agenda", "custom_summary", "tags", "sort_order".
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
namestring or objectOptionalCommit only if the previous name 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.
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.
tagsarray of string or objectOptionalCommit only if the previous tags 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.
sort_ordernumber or objectOptionalCommit only if the previous sort_order 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.
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.
itemMeetingTemplateRecordRequiredThe requested record, including its metadata and data fields.
MeetingTemplateRecord
idstringRequiredStable core:MeetingTemplate 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.
dataMeetingTemplateRequiredThe record's fields.
MeetingTemplate
Template3 fields
namestringRequiredName used to select this meeting template.
tagsarray of stringOptionalStable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.
sort_ordernumberOptionalRelative ordering value used to display templates.
Content2 fields
agendaarray of objectOptionalDefault two-level agenda to use when applying this template.
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".
custom_summaryobjectOptionalInstructions and optional example for generating summaries from meetings using this template.
Nested fields
examplestringOptionalExample output illustrating the desired summary style.
instructionsstringOptionalInstructions to follow when generating the summary.
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:MeetingTemplate` record. Find it with [meetings.ListMeetingTemplates](/reference/meetings/ListMeetingTemplates). Use the record's top-level `id`, not a business field or account ID."
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name used to select this meeting template."
},
"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": "Default two-level agenda to use when applying this template."
},
"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 for generating summaries from meetings using this template."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
},
"sort_order": {
"type": "number",
"description": "Relative ordering value used to display templates."
}
},
"required": [],
"additionalProperties": false,
"description": "The fields to set.",
"title": "MeetingTemplate"
},
"unset": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"agenda",
"custom_summary",
"tags",
"sort_order"
]
},
"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": {
"name": {
"description": "Commit only if the previous name value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Name used to select this meeting template."
},
{
"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": "Default two-level agenda to use when applying this template."
},
{
"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 for generating summaries from meetings using this template."
},
{
"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
}
]
},
"tags": {
"description": "Commit only if the previous tags value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
},
{
"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
}
]
},
"sort_order": {
"description": "Commit only if the previous sort_order value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "number",
"description": "Relative ordering value used to display templates."
},
{
"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_meetingtemplate_example",
"data": {
"name": "Customer project kickoff"
}
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable core:MeetingTemplate 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": {
"name": {
"type": "string",
"description": "Name used to select this meeting template."
},
"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": "Default two-level agenda to use when applying this template."
},
"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 for generating summaries from meetings using this template."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
},
"sort_order": {
"type": "number",
"description": "Relative ordering value used to display templates."
}
},
"required": [
"name"
],
"additionalProperties": false,
"description": "The record's fields.",
"title": "MeetingTemplate"
}
},
"required": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data"
],
"additionalProperties": false,
"description": "The requested record, including its metadata and data fields.",
"title": "MeetingTemplateRecord"
}
},
"required": [
"item"
],
"additionalProperties": false,
"examples": [
{
"item": {
"id": "e_meetingtemplate_example",
"created_at": 1791276900000,
"updated_at": 1791280800000,
"created_by": "a_jamie",
"private": false,
"data": {
"name": "Customer project kickoff",
"agenda": [
{
"id": "objectives",
"name": "Objectives",
"status": "None"
},
{
"id": "next-steps",
"name": "Next steps",
"status": "None"
}
],
"custom_summary": {
"instructions": "Summarize decisions, action owners and due dates."
}
}
}
}
]
}