Fineguide icon

Fineguide

Interact with Fineguide REST API v1

Actions13

Metadata → Patch

AI-generated

Summary

Partially update the metadata of a specific session associated with a given bot by sending a JSON object containing the changes to apply.

Inputs

  • Bot ID (required) — The ID of the bot for which the session metadata will be patched.
  • Session ID (required) — The ID of the session whose metadata is to be partially updated.
  • Metadata (required) — A JSON object representing the metadata fields and values to be updated or added in the session's metadata.

Output shape

a single JSON object reflecting the updated metadata response from the Fineguide API for the patched session metadata

The metadata input must be provided as a valid JSON object. The request uses HTTP PATCH to partially update session metadata without replacing entire data. Errors are returned in the JSON response if the operation fails.

Discussion