POST
/
v1
/
trace-learn
/
onboarding
/
tutor
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.completeTraceLearnTutorOnboarding({
  body: {},
})
{
  "actor": {
    "actorId": "<string>",
    "displayName": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>",
    "studentId": "<string>",
    "learnerKey": "<string>",
    "adminGrants": []
  },
  "profile": {
    "displayName": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>",
    "studentId": "<string>"
  },
  "student": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "targetSchool": "<string>",
    "learnerKey": "<string>",
    "credential": {
      "username": "<string>",
      "pinSet": true,
      "credentialKind": "student_username_pin"
    }
  },
  "links": [
    {
      "id": "<string>",
      "studentId": "<string>"
    }
  ],
  "entitlement": {},
  "firstDestination": "<string>",
  "nextSteps": [
    "<string>"
  ]
}

Body

application/json
tutorDisplayName
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
tutorEmail
string
required

a string at most 254 character(s) long

Required string length: 3 - 254
practiceName
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
studentCountBand
enum<string>
required
Available options:
1-5,
6-15,
16-30,
30+
examFamilyIds
string[]
required

a string at most 128 character(s) long

Required string length: 1 - 128
painPoint
enum<string>
required
Available options:
finding-practice-questions,
tracking-progress,
assigning-homework,
reporting-to-parents
defaultExamFamilyId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128

Response

Success

actor
object
required
profile
object
required
student
object
required
entitlement
object
required
firstDestination
string
required
nextSteps
string[]
required