Skip to content

API reference

Set meeting summary emails

meetings.SetMeetingSummaryEmailsWriteMember delegation

Choose who receives the caller's automatic meeting-summary emails: all attendees, external attendees, colleagues only or nobody.

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

Access & visibility

Allow meetings.SetMeetingSummaryEmails on your API key.

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.

scopestringRequired

Automatic attendee-email audience for meetings hosted by the acting member: all includes external attendees, external means only people outside the workspace, internal means workspace colleagues only, and off disables attendee emails. This is a delivery preference, not meeting visibility.

Allowed: "all", "external", "internal", "off".

Change the host's future delivery preference

With member delegation, this updates the approved acting member's own preference, not a workspace-wide default. Automatic delivery reads the meeting host's preference when a summary is generated. This call saves a setting; it does not send old summaries, recall delivered messages or confirm any later delivery.

The default attendee setting is off when no preference is stored. The host's own summary email has a separate setting: off here does not disable that personal copy. Review current preferences in Brigg Settings; this operation returns the newly saved value rather than the previous one.

Response

Returns 200 OK with a JSON body.

scopestringRequired

The saved attendee-email preference, matching the requested scope. It does not report a message send or delivery outcome.

Allowed: "all", "external", "internal", "off".

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.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "all",
        "external",
        "internal",
        "off"
      ],
      "description": "Automatic attendee-email audience for meetings hosted by the acting member: all includes external attendees, external means only people outside the workspace, internal means workspace colleagues only, and off disables attendee emails. This is a delivery preference, not meeting visibility."
    }
  },
  "required": [
    "scope"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "scope": "internal"
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "all",
        "external",
        "internal",
        "off"
      ],
      "description": "The saved attendee-email preference, matching the requested scope. It does not report a message send or delivery outcome."
    }
  },
  "required": [
    "scope"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "scope": "internal"
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.