Update privacy settings — Brigg developers

Access & visibility

Allow workspace.UpdatePrivacySettings on your API key.

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.

retentionstringOptional

Transcript policy: immediate deletes verbatim text once the closing summary exists; hours24 keeps the archive for one day; days30, days90, days180 and days365 retain it for that many days; forever has no automatic expiry. This governs transcripts, not the meeting's saved summary.

Allowed: "immediate", "hours24", "days30", "days90", "days180", "days365", "forever".

ai_disclosure_reminder_enabledbooleanOptional

Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself.

ai_disclosure_reminder_messagestring or nullOptional

Custom reminder; null or whitespace resets to the localized built-in message. Omit to preserve the current value.

ai_disclosure_notice_enabledbooleanOptional

Enable or disable the invitation notice. The resulting enabled state must have nonblank text; include ai_disclosure_notice_text when none is saved.

ai_disclosure_notice_textstring or nullOptional

Text to append to eligible invitations. Omit to preserve it; null or whitespace clears it only when the notice is disabled.

Separate retention, host reminders and attendee notices

These are workspace policies, not the acting member's personal preferences. Any active member can read them; canManage tells you whether that member is a workspace owner or administrator who may change them. The API key needs the update operation as well as approved delegation to that manager.

The reminder is a private prompt to the host when recording starts. The notice adds disclosure text to eligible future Google/Microsoft invitations with a conference URL and an external attendee that Brigg has permission to update. Changing settings does not prove that every provider invitation has already been updated.

Use the exact values in retentionOptions when changing retention. A shorter policy can cause existing archived transcripts to expire; immediate deletes verbatim text after its closing summary exists. Saved summaries are separate. A deleted transcript cannot be recovered by selecting a longer policy later.

Response

Returns 200 OK with a JSON body.

Send only the settings you intend to change. Omitted settings remain unchanged. Read GetPrivacySettings after the save when you also need supported values, localized defaults or management capability.

okbooleanRequired

Whether the action completed successfully.

retentionstringRequired

ai_disclosure_reminder_enabledbooleanRequired

Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself.

ai_disclosure_reminder_messagenull or stringOptional

Custom host-reminder text, or null to use the localized built-in message.

ai_disclosure_notice_enabledbooleanRequired

Whether Brigg adds the disclosure text to eligible connected-calendar invitations. This is separate from the private host reminder.

ai_disclosure_notice_textnull or stringOptional

Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text.

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.
400	`disclosure_notice_text_required`	The resulting enabled invitation notice has no text. Supply nonblank ai_disclosure_notice_text, or disable the notice when clearing it.

Next steps

Get privacy settings

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "retention": {
      "type": "string",
      "enum": [
        "immediate",
        "hours24",
        "days30",
        "days90",
        "days180",
        "days365",
        "forever"
      ],
      "description": "Transcript policy: immediate deletes verbatim text once the closing summary exists; hours24 keeps the archive for one day; days30, days90, days180 and days365 retain it for that many days; forever has no automatic expiry. This governs transcripts, not the meeting's saved summary."
    },
    "ai_disclosure_reminder_enabled": {
      "type": "boolean",
      "description": "Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself."
    },
    "ai_disclosure_reminder_message": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500,
          "description": "Custom reminder; null or whitespace resets to the localized built-in message. Omit to preserve the current value."
        },
        {
          "type": "null",
          "description": "Custom reminder; null or whitespace resets to the localized built-in message. Omit to preserve the current value."
        }
      ],
      "description": "Custom reminder; null or whitespace resets to the localized built-in message. Omit to preserve the current value."
    },
    "ai_disclosure_notice_enabled": {
      "type": "boolean",
      "description": "Enable or disable the invitation notice. The resulting enabled state must have nonblank text; include ai_disclosure_notice_text when none is saved."
    },
    "ai_disclosure_notice_text": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500,
          "description": "Text to append to eligible invitations. Omit to preserve it; null or whitespace clears it only when the notice is disabled."
        },
        {
          "type": "null",
          "description": "Text to append to eligible invitations. Omit to preserve it; null or whitespace clears it only when the notice is disabled."
        }
      ],
      "description": "Text to append to eligible invitations. Omit to preserve it; null or whitespace clears it only when the notice is disabled."
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "retention": "days30"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "retention": {
      "type": "string",
      "description": "Transcript policy: immediate deletes verbatim text once the closing summary exists; hours24 keeps the archive for one day; days30, days90, days180 and days365 retain it for that many days; forever has no automatic expiry. This governs transcripts, not the meeting's saved summary."
    },
    "ai_disclosure_reminder_enabled": {
      "type": "boolean",
      "description": "Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself."
    },
    "ai_disclosure_reminder_message": {
      "description": "Custom host-reminder text, or null to use the localized built-in message.",
      "title": "OpenAdThreadSubtaskAgent_phase",
      "anyOf": [
        {
          "type": "null",
          "description": "Custom host-reminder text, or null to use the localized built-in message."
        },
        {
          "type": "string",
          "description": "Custom host-reminder text, or null to use the localized built-in message."
        }
      ]
    },
    "ai_disclosure_notice_enabled": {
      "type": "boolean",
      "description": "Whether Brigg adds the disclosure text to eligible connected-calendar invitations. This is separate from the private host reminder."
    },
    "ai_disclosure_notice_text": {
      "description": "Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text.",
      "title": "OpenAdThreadSubtaskAgent_phase",
      "anyOf": [
        {
          "type": "null",
          "description": "Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text."
        },
        {
          "type": "string",
          "description": "Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text."
        }
      ]
    }
  },
  "required": [
    "ok",
    "retention",
    "ai_disclosure_reminder_enabled",
    "ai_disclosure_notice_enabled"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true,
      "retention": "days30",
      "ai_disclosure_reminder_enabled": true,
      "ai_disclosure_reminder_message": null,
      "ai_disclosure_notice_enabled": false,
      "ai_disclosure_notice_text": null
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Confirm the deletion implications before shortening retention. Other saved settings remain unchanged.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "retention": "days30"
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "retention": "days30"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "retention": "days30"
}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "retention": "days30"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "retention": "days30"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "retention": "days30"
}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true,
  "retention": "days30",
  "ai_disclosure_reminder_enabled": true,
  "ai_disclosure_reminder_message": null,
  "ai_disclosure_notice_enabled": false,
  "ai_disclosure_notice_text": null
}

Illustrative values, not a live response.

Supply both fields when the notice has no saved text.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "ai_disclosure_notice_enabled": true,
  "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "ai_disclosure_notice_enabled": true,
    "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "ai_disclosure_notice_enabled": True,
  "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "ai_disclosure_notice_enabled": true,
  "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "ai_disclosure_notice_enabled": true,
    "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "ai_disclosure_notice_enabled": True,
  "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdatePrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true,
  "retention": "days30",
  "ai_disclosure_reminder_enabled": true,
  "ai_disclosure_reminder_message": null,
  "ai_disclosure_notice_enabled": true,
  "ai_disclosure_notice_text": "Note: AI will be used to transcribe and analyze this meeting."
}

Illustrative values, not a live response.