Settings for bookmarks

This page describes the user settings that are available for the Bookmarks feature using the Management API. With the Management API, you can set a default value for some parameters of your bookmark requests.

This request uses RFC 6902 patch operations to update user settings.

For more information about the Bookmarks feature, see Bookmarks.

For more information about user settings, see User Settings.


Settings for bookmarks - Management API

This section provides a basic example of how to update your user settings for bookmarks using the Management API.

To update user settings for bookmarks with the Management API, use the PATCH <https://api.symbl.ai/v1/manage/settings> operation. For more information about this operation, such as details about the request body, see Update User Settings.

The following table describes the settings that Symbl.ai supports for bookmarks. The table includes the path for the setting, which is used when you update user settings.

Setting

Path

Description

duration

/intelligence/bookmarks/duration

This path supports the add and replace operations.

When a bookmark is created or updated, the default duration of the bookmark in seconds.

When a value for this setting exists, if no value is provided for the duration parameter when you create or update a bookmark, the value of this setting is used instead.

Authentication

These requests require an access token, as described in Authenticate.

Example request - add duration

The following example demonstrates how to add a value for the duration setting. For more information about the request, see Update User Settings.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const settings = [
  {
    "op": "add",
    "path": "/intelligence/bookmarks/duration",
    "value": 30
  }
]

const fetchResponse = await fetch(`https://api.symbl.ai/v1/manage/settings`, {
  method: patch,
  body: JSON.stringify(settings),
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.

Example request - replace duration

The following example demonstrates how to replace an existing value for the duration setting. For more information about the request, see Update User Settings.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const settings = [
  {
    "op": "replace",
    "path": "/intelligence/bookmarks/duration",
    "value": 30
  }
]

const fetchResponse = await fetch(`https://api.symbl.ai/v1/manage/settings`, {
  method: patch,
  body: JSON.stringify(settings),
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.

Response

The following table describes the response body that is returned by this request.

FieldDescription
intelligenceContains settings objects for Symbl.ai’s Conversation Intelligence features.
intelligence.bookmarksContains settings for the Bookmarks feature.
intelligence.bookmarks.durationIn seconds, the default duration for a bookmark.

Example response

{
  "intelligence": {
    "bookmarks": {
      "duration": 30
    }
}

Did this page help you?