PATCH
/
v1
/
learning
/
tutor
/
students
/
{studentId}
/
notes
/
{noteId}
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.updateTraceLearnTutorStudentNote({
  studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? "studentId",
  noteId: process.env.TX_AGENT_KIT_NOTE_ID ?? "noteId",
  body: {},
})
{
  "id": "<string>",
  "studentId": "<string>",
  "sessionDate": "<string>",
  "tags": [],
  "body": "<string>",
  "authorDisplayName": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Path Parameters

studentId
string
required
noteId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json
body
string

a string at most 2000 character(s) long

Required string length: 1 - 2000
sessionDate
string

a string matching the pattern ^\d{4}-\d{2}-\d{2}$

Pattern: ^\d{4}-\d{2}-\d{2}$
tags
enum<string>[]

an array of at most 4 item(s)

Maximum array length: 4
Available options:
strength,
concern,
homework,
follow_up

Response

Success

id
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
sessionDate
string
required

a string matching the pattern ^\d{4}-\d{2}-\d{2}$

Pattern: ^\d{4}-\d{2}-\d{2}$
tags
enum<string>[]
required
Available options:
strength,
concern,
homework,
follow_up
body
string
required
authorDisplayName
string
required
createdAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
updatedAt
string
required

a string at least 10 character(s) long

Minimum string length: 10