The language_preference field controls the language in which the system communicates with a candidate or user throughout their experience. The API accepts two formats:
Standard language codes follow BCP 47 conventions (e.g., en, fr, pt-br) and must be sent in lowercase exactly as shown in the table below. Regional variants use a hyphen separator — for example, es for Spanish (LATAM), es-mx for Spanish (Mexico), and es-em for Modern Spain Spanish.
Locale-style aliases (e.g., it_it, ja_jp, pt_br) are also accepted for backwards compatibility and are case-insensitive — IT_IT, It_It, and it_it are all treated equivalently. These aliases are automatically mapped to their corresponding standard code.
If no value is provided, the field defaults to en (English).
Standard Language Codes:
| Code | Language |
|---|---|
| en | English |
| en-gb | British English |
| es | Spanish (LATAM) |
| es-em | Spanish (Modern Spain) |
| es-mx | Spanish (Mexico) |
| fr | French |
| fr-ca | French (Canadian) |
| de | German |
| it | Italian |
| nl | Dutch |
| pt | Portuguese (Portugal) |
| pt-br | Brazilian Portuguese |
| zh-cn | Simplified Chinese |
| zh-tw | Traditional Chinese |
| ja | Japanese |
| ko | Korean |
| vi | Vietnamese |
| th | Thai |
| tr | Turkish |
| ru | Russian |
| ar | Arabic |
| he | Hebrew |
| hu | Hungarian |
| pl | Polish |
| ro | Romanian |
| bg | Bulgarian |
| bs | Bosnian |
| hr | Croatian |
| cs | Czech |
| el | Greek |
| sk | Slovak |
| sr | Serbian (Cyrillic) |
| uk | Ukrainian |
| da | Danish |
| sv | Swedish |
| ms | Malay |
| id | Indonesian |
| km | Khmer |
Locale-style aliases
| Alias | Maps to |
|---|---|
| it_it | it |
| ja_jp | ja |
| ko_kr | ko |
| pt_br | pt-br |
| zh_cn | zh-cn |
| es | es |
| zh_tw | zh-tw |
| tr_tr | tr |
| en_us | en |
| fr_fr | fr |
| ru_ru | ru |
| de_de | de |
| fr_ca | fr-ca |
| nl_nl | nl |
| hu | hu |
| vi | vi |
| bs | bs |
| he | he |
| es_mx | es-mx |