Help › Reference: every action › Actions that change something
Accounts and settings
user.create: Create account. Parameters: {name: string, email: string, passwordHash: string, role?: "student"|"teacher", classCode?: string}
user.createFromInvite: Create account from an invitation. Parameters: {tokenHash: string, name: string, passwordHash: string}
user.setPasswordFromLink: Choose your password (emailed link). Parameters: {tokenHash: string, passwordHash: string}
user.chooseRole: Choose your role. On the pages: Classes. Parameters: {role: "student"|"teacher"}
user.setPassword: Change password. On the pages: Settings ▸ Password. Parameters: {passwordHash: string}
user.resetPassword: Reset password. On the pages: People. Parameters: {user: id, passwordHash: string}
user.setPrefs: Settings. On the pages: Settings. Parameters: {textSize?: "normal"|"large"|"larger", highContrast?: bool, reduceMotion?: bool, timeZone?: "Area/City"|"", emailSummary?: bool, language?: "en"|"ar"|"", mascotMessages?: bool, honourBoards?: bool, notifyNewWork?: bool, notifyReturned?: bool, notifyDueTomorrow?: bool, notifyLiveSoon?: bool, notifyMentions?: bool, notifyComments?: bool, emailFirst?: bool, pushFirst?: bool, shortcuts?: "letters"|"alt"|"off", tips?: bool}
user.deviceTimeZone: Time zone from your device. On the pages: Settings. Parameters: {timeZone: "Area/City"}
user.changeEmail: Change email. On the pages: Settings. Parameters: {email: string, passwordOk: bool, tokenHash?: string}
user.confirmEmail: Confirm a new email (emailed link). Parameters: {tokenHash: string}
avatar.set: Choose what the mascot wears. On the pages: My achievements. Parameters: {worn: ["glasses"|"hat"|"scarf"|"bowTie"|"cape"|"crown"]}
user.dismissWelcome: Close the welcome. On the pages: Classes. Parameters: {}
user.setName: Your name. On the pages: Settings. Parameters: {name: string}
user.setPicture: Save profile picture. On the pages: Settings ▸ Profile picture. Parameters: {picture: "initials"|"drawn"|"photo", animal?: "bear"|"cat"|"owl"|"fox"|"rabbit"|"penguin"|"lion"|"turtle", colour?: 0-7, file?: fileId, name?: string, size?: number}
user.removePhoto: Remove photo. On the pages: Class ▸ People. Parameters: {user: id}