POST
/
v1
/
trace-learn
/
parent
/
children
/
{studentId}
/
tutor-invites
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.inviteTraceLearnTutorForChild({
  studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? "studentId",
  body: {},
})
{
  "inviteId": "<string>",
  "studentId": "<string>",
  "tutorEmail": "<string>",
  "message": "<string>",
  "createdAt": "<string>"
}

Path Parameters

studentId
string
required

Body

application/json
tutorEmail
string
required

a string at most 254 character(s) long

Required string length: 3 - 254
note
string

a string at most 500 character(s) long

Maximum string length: 500

Response

Success

inviteId
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
tutorEmail
string
required
state
enum<string>
required
Available options:
invited,
already_connected
message
string
required
createdAt
string
required

a string at least 10 character(s) long

Minimum string length: 10