The term “learner” is equivalent to end user in the platform.
mutation {
createLearner(companyId: ID, externalCompanyId: ID, email:String!, firstName:String!, lastName:String!, groupIds: [ID], learnerId: String, locale: LanguageCode, excludedFromAutoEnrol: Boolean): Learner!
}
# Duplicate learners will be ignored or updated
mutation {
createLearners(learners: [UploadedLearner]!, companyId: ID!): LearnerUpload
}
input UploadedLearner {
email: String
firstName: String
lastName: String
learnerId: String
groups: [String]
excludedFromAutoEnrol: Boolean
locale: LanguageCode
managerId: ID
}
# The companyId and externalCompanyId variables are used for access control and can be used to change the learner's company
mutation {
editLearner(
companyId: ID, externalCompanyId: ID,
id: ID!, email:String, firstName: String!, lastName:String!,
groupIds: [ID], learnerId: String, locale: LanguageCode, excludedFromAutoEnrol: Boolean
): Learner!
}
mutation {
deleteLearner(id: ID!, companyId: ID, externalCompanyId: ID): Boolean!
}
mutation {
deleteLearners(learnerIds: [ID!]!, companyId: ID!): Boolean!
}
mutation {
markLearnersInactive(learnerIds: [ID!]!, companyId: ID!): [Learner]!
}
mutation {
markLearnersActive(learnerIds: [ID!]!, companyId: ID!): [Learner]!
}