• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Documentation

APIs

Home › Litmos Documentation › Teams – Perform Assignments Via API

Teams – Perform Assignments Via API

Assign Courses to a Team

Add a list of courses to a Team. If the courses already exist in the team, or if the course Ids are invalid, they will be ignored. Emails will be sent notifying the users of the course assignments, providing they have previously logged into their account. It is possible to disable sending course invitation emails by adding the following querystring parameter to the end of the uri : &sendmessage=false .

Important Notes:

  • A course is be added to a team or to the course team library using the same request. . To add the course to both the team and the course team library, make two separate requests with different values for <CourseTeamLibrary>true/false</CourseTeamLibrary> parameter.
  • In order to assign a course to the Team Courses tab, CourseTeamLibrary>false</CourseTeamLibrary> must be passed in the request body. If the value is true, then the course will only be added to the Team Course library.
  • To perform the course assignments to all subteams, append this parameter to the URI &includesubteams=true .

Request URI

POST /teams/{teamid}/courses?

Request Body

<Courses>
    <Course>
        <Id>string [max length 50]</Id>
        <CourseTeamLibrary>true/false</CourseTeamLibrary>
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
    </Course>
</Courses>

Response Header

200 OK

Un-assign Courses from a Team

Remove a list of courses from a Team. If the courses do not exist in the team, or if the course Ids are invalid, they will be ignored.

Important Notes:

  • A course can’t be removed from the team and the course team library in one request. To remove the course from both the team and course team libraries, make two separate requests with different values for <CourseTeamLibrary>true/false</CourseTeamLibrary> field.
  • In order to remove a course from the Team Course Library, <CourseTeamLibrary>true </CourseTeamLibrary> value must be passed. To remove the course from the Team Courses tab the value should be <CourseTeamLibrary>false</CourseTeamLibrary>.

Request URI

DELETE /teams/{teamid}/courses?

Request Body (XML)

<Courses>
    <Course>
        <Id>string [max length 50]</Id>
        <CourseTeamLibrary>true/false</CourseTeamLibrary>
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
    </Course>
</Courses>

Response

200 OK

Assign Learning Paths to a Team

Add a list of learning paths to a Team. If the learning paths already exist in the team, or if the learning path Id’s are invalid, they will be ignored. Emails will be sent notifying the users of the learning path assignments, providing they have previously logged into their account. It is possible to disable sending learning path invitation emails by adding the following querystring parameter to the end of the uri : &sendmessage=false .

Important Notes:

  • A learning path is be added to a team or to the learning path team library using the same request. To add the learning path to both the team and the learning path team library, make two separate requests with different values for the <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary> field.
  • In order to assign a learning path to the Team Learning Paths tab, <LearningPathTeamLibrary>false</LearningPathLibrary> must be passed in the request body. If the value is true, then the learning path will only be added to the Team Learning Path library.

Request URI

POST /teams/{teamid}/learningpaths?

Request Body (XML)

<LearningPaths>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary>
    </LearningPath>
    <LearningPath>
        <Id>string [max length 50]</Id>
    </LearningPath>
</LearningPaths>

Response

200 OK

Un-assign Learning Paths from a Team

Remove a list of Learning Paths from a Team. If the learning paths do not exist in the team, or if the learning path Ids are invalid, they will be ignored.

Important Notes:

  • A learning path can’t be removed from the team and the Learning Path Team Library in one request. To remove the course from both the Team Library and Learning Path Team libraries, make two separate requests with different values for the <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary> field.
  • In order to remove a learning path from the Team Learning Path Library, <LearningPathTeamLibrary>true </LearningPathTeamLibrary> value must be passed. To remove the learning path from the Team LearningPaths tab the value should be <CourseTeamLibrary>false</CourseTeamLibrary>.

Request URI

DELETE /teams/{teamid}/learningpaths?

Request Body (XML)

<LearningPaths>  
    <LearningPath>  
        <Id>string [max length 50]</Id>
        <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary>   
    </LearningPath>  
    <LearningPath>  
        <Id>string [max length 50]</Id>  
    </LearningPath>  
</LearningPaths>

Response Header

200 OK

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. Users Via API
  2. Date Range Delta Queries Via API
  3. Team Admin And Team Leaders

Also of Interest

  • Online Learning Tools
  • Online Learning Companies
  • Content Authoring Tools
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms