Policies

Update a policy

Writes only the fields you send. Each owner takes a subset:

  • Workspace: everything except recording.enabled. Needs a plan with notetaker customization.
  • Member: everything except recording.enabled and branding.
  • Meeting: recording.enabled, recording.methods.bot.mode, transcription.language and summary.template. A change applies to this occurrence and every later one of the series. A meeting started by a bot takes recording.enabled: false (stop), and, while upcoming, transcription.language, summary.language, summary.template and recording.methods.bot.silence_detection.alert; what the bot was dispatched with (recording.methods.bot.start and .mode) answers 409 not_supported.

A field the policy does not have is refused with 422 and unknown_field.

Turning a meeting's recording off stops every bot of that meeting, whoever sent it: a scheduled bot is withdrawn and one in the call leaves, keeping what it recorded. While a bot is still joining the call the write answers 503; retry a few seconds later. A live meeting only takes recording.enabled: false.

Upcoming meetings are re-evaluated and a meeting.updated webhook is sent for each one that changes.

patch/policies/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Request body

Example request

{
  "policy": {
    "recording": {
      "scope": [
        "meetings:external"
      ]
    }
  }
}

Response

The updated policy.

object'policy'

Always policy.

Example response

{
  "object": "policy",
  "owner": {
    "type": "member",
    "id": "mem_01k69x9s8x7c2dvq3m5n6p4ab"
  },
  "policy": {
    "recording": {
      "scope": [
        "meetings:external"
      ],
      "methods": {
        "bot": {
          "start": "on_join",
          "mode": "audio_and_video",
          "silence_detection": {
            "alert": true
          }
        }
      }
    },
    "transcription": {
      "language": "auto"
    },
    "summary": {
      "template": "discovery_call",
      "language": "en"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.