Skip to main content
Use summary operations to read structured meeting outcomes, replace the approved internalNotes field, and approve a caller-created summary that is waiting for approval.

Prerequisites

You need meetings:read to list or retrieve summaries and meetings:write to update notes or approve a summary. Set these values once in your shell before running the examples:
Use a personal access token created for this workspace. The examples use synthetic IDs and values; replace them with values returned by your workspace.
Keep FLORAL_TOKEN in a secret manager outside local development. Never commit it to source control or include it in logs.

List and filter summaries

Summary collections use opaque cursor pagination. Filter by state, company, appointment time, or evidence audience.
The supported states are WAITING, WAITING_APPROVAL, APPROVED, and FAILED. Evidence audience is CUSTOMER or INTERNAL. Pass a non-null nextCursor as cursor for the next page.

Retrieve a summary and its version

Get the current summary immediately before changing it. Copy the strong ETag response header exactly, including its quotes.
Treat content as the structured public summary. It can be null while the summary is not ready.

Replace summary notes

The partial-update operation accepts only internalNotes. Sending a string replaces the complete field; sending null clears it. Other summary fields are rejected.
Save the new ETag from the response before approving the summary.

Approve the current summary

Approval requires the latest ETag and a unique idempotency key. Omit the optional request body to approve the current appointment time and structured content.
A successful response has APPROVED status and includes a new ETag. Approval is valid only for a caller-created summary in WAITING_APPROVAL; another state returns 409 INVALID_STATE. If the response is interrupted, retry the identical approval with the same key and version. Floral replays the original result. Never reuse the key for another summary or edited approval input.

Clear summary notes

Reload the summary to get its current ETag, then send null:
Floral protects writes with two opaque values:
  • Send a unique Idempotency-Key when an operation requires one. Retrying the identical request with the same key replays its result for 24 hours. Within that operation, reusing the key with different canonical input returns 409 IDEMPOTENCY_CONFLICT.
  • Send the latest strong ETag as If-Match when an operation changes an existing resource. A stale value returns 412 VERSION_CONFLICT; a missing value returns 428 PRECONDITION_REQUIRED.
Keep the quote characters around an ETag, and replace your saved value after every successful write. See Reliability and retries for the complete retry rules.