PUT
/
v1
/
learning
/
parent
/
coverage
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.setTraceLearnParentFamilyCoverage({
  body: {},
})
{
  "limit": 4,
  "children": [
    {
      "studentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "coveredByParent": true,
      "selectedForParent": true,
      "canAccessLearning": true,
      "sources": [],
      "trialEndsAt": "<string>"
    }
  ]
}

Body

application/json
mode
enum<string>
required
Available options:
automatic,
manual
studentIds
string<uuid>[]
required

an array of at most 4 item(s)

Maximum array length: 4

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}$

Response

Success

mode
enum<string>
required
Available options:
automatic,
manual
limit
enum<number>
required
Available options:
4
children
object[]
required