Sign in
latestOpenAPI 3.1.02026-08-0817082.3 KB

cac8702ed2aa

Learners

Create a new learner

Create a new learner.

post/v1/learners

Request body

namestring required

The learner's full name.

emailstring email required

The learner's unique email address.

country'AFG' | 'ALA' | 'ALB' | 'DZA' | 'ASM' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BMU' | 'BTN' | 'BOL' | 'BES' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'VGB' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COG' | 'COD' | 'COK' | 'CRI' | 'CIV' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'SWZ' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRN' | 'IRQ' | 'IRL' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MAC' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'PRK' | 'MKD' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'KOR' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWE' | 'CHE' | 'SYR' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TCA' | 'TUV' | 'UGA' | 'UKR' | 'ARE' | 'GBR' | 'USA' | 'UMI' | 'URY' | 'UZB' | 'VUT' | 'VAT' | 'VEN' | 'VNM' | 'VIR' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE' required

The learner's country of employment. Three letter country code.

state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'DC' | 'FM' | 'GU' | 'MH' | 'MP' | 'PW' | 'PR' | 'VI'

The learner's state of employment. Two letter state code.

Validation rules:

  • Required when country is "USA"
  • Must be null or omitted for all other countries
  • Empty strings ("") are not allowed

Examples:

  • "USA" + "NY" ✅
  • "USA" + null ❌
  • "CAN" + null ✅
  • "CAN" + "ON" ❌ (Canadian provinces not supported)
isManagerboolean required

Whether the learner is a manager.

managerLearnerIdstring

The unique identifier of a learner.

departmentstring

The department the learner belongs to.

workerTypestring

The learner's worker type.

customCategorystring

The learner's custom category. Can be populated with any value. For example, the office or city of a learner.

languagestring required

The learner's language. Represented as any Unicode CLDR language documented here: https://cldr.unicode.org/

⚠️ Important: Use language codes (e.g., "en"), not language names (e.g., "English").

✅ Common valid examples:

  • "en": English
  • "es": Spanish
  • "es-419": Spanish (Latin America)
  • "es-MX": Spanish (Mexico)
  • "zh": Chinese
  • "zh-TW": Chinese (Taiwan)
  • "zh-Hant-HK": Chinese (traditional, Hong Kong)
  • "fr": French
  • "de": German

❌ Common invalid examples, which will cause validation errors:

  • "English" (use "en" instead)
  • "Spanish" (use "es" instead)
  • "Chinese" (use "zh" instead)

Example request

{
  "name": "First Last",
  "email": "first.last@{your-domain}.com",
  "country": "USA",
  "state": "NY",
  "isManager": true,
  "managerLearnerId": "abc123def4",
  "department": "Engineering",
  "workerType": "Full Time",
  "customCategory": "Brooklyn",
  "language": "en"
}

Response

Created

idstring required

The unique identifier of a learner.

Example response

{
  "id": "abc123def4"
}