Language branches

6 min

📘 The Language Branch API is available only in version 3.4.0 or later of the Optimizely Content Definitions API.

Language branches are definitions of language and regions that should be available for creating content.

Example language branch definition

{
  "name"        : "en-NZ",
  "displayName" : "English (New Zealand)",
  "urlSegment"  : "en_nz",
  "sortOrder"   : 50,
  "enabled"     : true
}

List language branches

List language branch definitions in the system.

GET /api/episerver/v3.0/languagebranches

Get language branch

Retrieve a language branch definition by name, such as de or en-UK.

GET /api/episerver/v3.0/languagebranches/{name}

Create a language branch

Creates a language branch definition.

POST /api/episerver/v3.0/languagebranches

Update or create a language branch

Updates the language branch definition with the provided name. If no language branch with the provided name exists, one is created. Any properties not provided in the payload are cleared.

PUT /api/episerver/v3.0/languagebranches/{name}

Patch language branch

Patches an existing language branch definition with the provided name. Only include the properties that you want to update in the payload.

PATCH /api/episerver/v3.0/languagebranches/{name}

Enable language branch example

Call PATCH /api/episerver/v3.0/languagebranches/en-nz with the following payload.

{
  "enabled" : true
}

Delete language branch

Deletes the language branch definition with the provided name. You can delete only unused language branch definitions.

DELETE /api/episerver/v3.0/languagebranches/{name}