PATCH
/
v1
/
trace-learn
/
notification-preferences
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.updateTraceLearnNotificationPreferences({
  body: {},
})
{
  "userAccountId": "<string>",
  "emailHomeworkCompletion": true,
  "emailHomeworkReminders": true,
  "emailWeeklyDigest": true,
  "emailSixWeeklySummary": true,
  "digestDayOfWeek": 3,
  "pushEnabled": true,
  "quietHoursStart": "<string>",
  "quietHoursEnd": "<string>",
  "updatedAt": "<string>"
}

Body

application/json
role
enum<string>
required
Available options:
parent,
tutor
emailHomeworkCompletion
boolean
emailHomeworkReminders
boolean
emailWeeklyDigest
boolean
emailSixWeeklySummary
boolean
digestDayOfWeek
integer

a number between 0 and 6

Required range: 0 <= x <= 6
pushEnabled
boolean
quietHoursStart
string

a string at most 5 character(s) long

Required string length: 5
quietHoursEnd
string

a string at most 5 character(s) long

Required string length: 5

Response

Success

userAccountId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
role
enum<string>
required
Available options:
parent,
tutor
emailHomeworkCompletion
boolean
required
emailHomeworkReminders
boolean
required
emailWeeklyDigest
boolean
required
emailSixWeeklySummary
boolean
required
digestDayOfWeek
integer
required

a number between 0 and 6

Required range: 0 <= x <= 6
pushEnabled
boolean
required
quietHoursStart
string
required
quietHoursEnd
string
required
updatedAt
string
required

a string at least 10 character(s) long

Minimum string length: 10