Skip to content

API reference

Create meeting template

meetings.CreateMeetingTemplateWriteAPI key

Create a meeting template and return the saved record.

POST/v1/operations/meetings.CreateMeetingTemplate
On this page

Access & visibility

Allow meetings.CreateMeetingTemplate 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.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

dataMeetingTemplateRequired

The record's fields.

MeetingTemplate
Template3 fields
namestringRequired

Name used to select this meeting template.

tagsarray of stringOptional

Stable 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_ordernumberOptional

Relative ordering value used to display templates.

Content2 fields
agendaarray of objectOptional

Default two-level agenda to use when applying this template.

Item fields
idstringOptional

Stable identifier of this agenda topic or subtopic.

namestringOptional

Topic or subtopic title.

statusstringOptional

Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.

Allowed: "None", "Touched", "Partial", "Full".

subtopicsarray of objectOptional

Second-level discussion topics; no deeper nesting is supported.

Item fields
idstringOptional

Stable identifier of this agenda topic or subtopic.

namestringOptional

Topic or subtopic title.

statusstringOptional

Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.

Allowed: "None", "Touched", "Partial", "Full".

custom_summaryobjectOptional

Instructions and optional example for generating summaries from meetings using this template.

Nested fields
examplestringOptional

Example output illustrating the desired summary style.

instructionsstringOptional

Instructions to follow when generating the summary.

privatebooleanOptional

Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance.

Choose ownership deliberately

Omitting private, or setting it to false, creates a workspace-shared record. Set private: true to create a record owned by the approved acting member. Private records require member delegation; a workspace-only credential cannot own a personal record. The credential’s exact resource grants authorize the write; private ownership and project membership remain enforced.

A create is a new record, not an upsert. Reuse the same idempotency key only for retries of that logical creation. For recurring synchronization, use the resource’s upsert operation when available: it matches a permanent external reference. Otherwise keep the returned record ID and use the corresponding update operation for subsequent changes.

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.

itemMeetingTemplateRecordRequired

The requested record, including its metadata and data fields.

MeetingTemplateRecord
idstringRequired

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_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

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.

privatebooleanRequired

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.

dataMeetingTemplateRequired

The record's fields.

MeetingTemplate
Template3 fields
namestringRequired

Name used to select this meeting template.

tagsarray of stringOptional

Stable 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_ordernumberOptional

Relative ordering value used to display templates.

Content2 fields
agendaarray of objectOptional

Default two-level agenda to use when applying this template.

Item fields
idstringOptional

Stable identifier of this agenda topic or subtopic.

namestringOptional

Topic or subtopic title.

statusstringOptional

Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.

Allowed: "None", "Touched", "Partial", "Full".

subtopicsarray of objectOptional

Second-level discussion topics; no deeper nesting is supported.

Item fields
idstringOptional

Stable identifier of this agenda topic or subtopic.

namestringOptional

Topic or subtopic title.

statusstringOptional

Topic coverage: None = not covered, Touched = mentioned, Partial = partly covered, Full = covered. Values are case-sensitive.

Allowed: "None", "Touched", "Partial", "Full".

custom_summaryobjectOptional

Instructions and optional example for generating summaries from meetings using this template.

Nested fields
examplestringOptional

Example output illustrating the desired summary style.

instructionsstringOptional

Instructions 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.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "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](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/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"
    },
    "private": {
      "type": "boolean",
      "description": "Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "data": {
        "name": "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."
        }
      }
    }
  ]
}
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](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/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": "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."
          }
        }
      }
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.