Languages

admin.languages manages the target languages of the project the client is scoped to. The source language is a project setting, changed under Settings, CDN Delivery, not through this namespace.

Add languages #

await admin.languages.add({
  languages: [
    { languageCode: "en-gb" },
    { languageCode: "en-ca" },
    { languageCode: "en-au", status: "draft" },
  ],
});

active languages are published to the CDN. draft languages are visible in the editor and left out of delivery, which is how you stage a locale before announcing it.

Up to 50 languages per call. The parameter also accepts a JSON string, for agents that serialize arrays that way:

await admin.languages.add({ languages: '[{"languageCode":"fr"}]' });

Update status #

await admin.languages.update({
  updates: [{ languageCode: "en-au", status: "active" }],
});

Archive languages #

await admin.languages.delete({ languageCodes: ["en-au"] });

Despite the name this archives rather than destroys: the status moves to archived and every translation is preserved. Re-adding the language brings its existing content back.

Regional locales #

Regional codes are first-class. A project can run en-us as its source with en-gb, en-ca and en-au as targets, and each locale gets its own file at /<locale>/translations.json.

await admin.languages.add({
  languages: [{ languageCode: "en-gb" }, { languageCode: "en-ca" }, { languageCode: "en-au" }],
});

Errors #

An unsupported language code returns a 400 naming the code. If you get one, check it against the language list in the dashboard, since the code has to exist in the platform's language table before a project can target it.