Skip to content

API reference

Set meeting template sharing

meetings.SetMeetingTemplateSharingWriteMember delegation

Share a meeting template with the workspace or return it to its owner's private templates without changing its content.

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

Access & visibility

Allow meetings.SetMeetingTemplateSharing on your API key. Resource write permissions: core:MeetingTemplate.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

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.

idstringRequired

Top-level id from List meeting templates. Use the template record identity, not a Meeting ID or a generated document template_id.

At least 1 character. At most 128 characters.

sharedbooleanRequired

True shares the template with the workspace; false returns it to its owner's private templates.

Share reading access while keeping responsibility

Sharing makes the template readable across the workspace. It does not give every reader authority to edit, delete or unshare it. For an already shared template, the member recorded as its responsible creator or a workspace owner/administrator can change sharing. Private templates must be visible to the acting member.

When unshared, the template returns to its recorded creator if that person remains an active member. Otherwise the acting member becomes its private owner. Existing content stays intact; future reads by other members can no longer find it. The response confirms the requested shared state, not the owner's account ID.

Response

Returns 200 OK with a JSON body.

okbooleanRequired

Whether the action completed successfully.

sharedbooleanRequired

Whether the meeting or template is shared with the workspace.

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. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
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.
400 not_a_meeting_template Use the id of a MeetingTemplate from ListMeetingTemplates, not a Meeting or document template.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Top-level id from [List meeting templates](/developers/reference/meetings/ListMeetingTemplates). Use the template record identity, not a Meeting ID or a generated document template_id."
    },
    "shared": {
      "type": "boolean",
      "description": "True shares the template with the workspace; false returns it to its owner's private templates."
    }
  },
  "required": [
    "id",
    "shared"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_template_project_review",
      "shared": true
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "shared": {
      "type": "boolean",
      "description": "Whether the meeting or template is shared with the workspace."
    }
  },
  "required": [
    "ok",
    "shared"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true,
      "shared": true
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.