Update Insights Folder

PUT/api/v1/insights/folders/{folder_id}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

folder_id integer path required

Request body

application/json

body InsightsFolderInput required

3 fields

namestringrequired

Human-readable name of insight folder

labelstring | nulloptional

optional label assigned to insight folder

descriptionstring | nulloptional

Text description of insight upload folder

Request example

{
  "name": "string",
  "label": "string",
  "description": "string"
}

Responses

200Successful Response

application/json

response InsightsFolder required

7 fields

namestringrequired

Human-readable name of insight folder

labelstring | nulloptional

optional label assigned to insight folder

descriptionstring | nulloptional

Text description of insight upload folder

idintegerrequired

System-assign folder ID

created_atstring (date-time)optional

Timestamp at which insight upload folder was created

updated_atstring (date-time)optional

Timestamp at which insight upload folder was last updated

last_updated_bystringrequired

Email of user who last updated upload folder

Response example

{
  "name": "string",
  "label": "string",
  "description": "string",
  "id": 0,
  "created_at": "string",
  "updated_at": "string",
  "last_updated_by": "string"
}

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Code examples

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.insights.folders.update({
    folderId: 567518,
    insightsFolderInput: {
      name: "customer-complaints",
      label: "support",
      description: "Call recordings related to customer complaints",
    },
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.insights.folders.update(folder_id=567518, insights_folder_input={
        "name": "customer-complaints",
        "label": "support",
        "description": "Call recordings related to customer complaints",
    })

    # Handle response
    print(res)

curl --request PUT \
  --url 'https://api.syllable.cloud/api/v1/insights/folders/%7Bfolder_id%7D' \
  --header 'content-type: application/json' \
  --data '{
  "name": "string",
  "label": "string",
  "description": "string"
}'