PATCH
/
v4
/
threads
/
{thread_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const chatThread = await client.chatThreads.update('thread_id');

  console.log(chatThread.id);
}

main();
{
  "id": "<string>",
  "title": "<string>",
  "application_variant_id": "<string>",
  "thread_metadata": {},
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
thread_id
string
required

Body

application/json
​
title
string

The title of the chat thread.

​
archived_at
string

Date when the chat thread is archived, or None to un-archive.

​
thread_metadata
object

The metadata associated with the thread

Response

200
application/json
Successful Response
​
id
string
required
​
title
string
required
​
application_variant_id
string
required
​
account_id
string
required

The ID of the account that owns the given entity.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_at
string
required

The date and time when the entity was created in ISO format.

​
updated_at
string
required

The date and time when the entity was last updated in ISO format.

​
thread_metadata
object
​
archived_at
string

The date and time when the entity was archived in ISO format.

Delete Chat ThreadPatch Chat Thread Entry