Create locale

1 min

POST

https://api.cms.optimizely.com/v1/locales

Create a new locale.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.

Body Parameters

bodyLocalerequired
Description
The locale that should be created.
- keystringrequired
  Description
  The unique identifier (key) of the resource. This is the IETF BCP-47 language tag (e.g., "en", "en-US", "sv-SE").
  Min Length
  1
- displayNamestringrequired
  Description
  The display name of this locale.
  Min Length
  1
  Max Length
  255
- isEnabledboolean
  Description
  Indicates whether this locale is enabled and can be used to create content.
- routeSegmentstringrequired
  Description
  A string that represents the segment that should be used when routing or generate routes to the current locale
  Min Length
  1
  Max Length
  255
- sortOrderinteger<int32>
  Description
  A value that is used when sorting locales.
  Format
  int32
- accessRightsSecurityIdentity[]
  Description
  The access rights assigned to this locale that defines who can create content in this locale. If no access rights are assigned, everyone will be able to create content in this locale. An empty array means that no user will be allowed to create or change content in this locale.
  - namestringrequired
    Description
    The unique name of the user, role or application that this identifier references.
    Min Length
    1
    Max Length
    255
  - typestring
    Examples
    user
    role
    application
    Description
    The type of the security entity that this identifier references. Will default to 'role' if not specified.
    Max Length
    50
- fallbackstring
  Description
  A fallback locale that should be used if content is not available in the current locale.

Responses

201Created

Locale
Description
A locale that can be used for content.
- keystringrequired
  Description
  The unique identifier (key) of the resource. This is the IETF BCP-47 language tag (e.g., "en", "en-US", "sv-SE").
  Min Length
  1
- displayNamestringrequired
  Description
  The display name of this locale.
  Min Length
  1
  Max Length
  255
- isEnabledboolean
  Description
  Indicates whether this locale is enabled and can be used to create content.
- routeSegmentstringrequired
  Description
  A string that represents the segment that should be used when routing or generate routes to the current locale
  Min Length
  1
  Max Length
  255
- sortOrderinteger<int32>
  Description
  A value that is used when sorting locales.
  Format
  int32
- accessRightsSecurityIdentity[]
  Description
  The access rights assigned to this locale that defines who can create content in this locale. If no access rights are assigned, everyone will be able to create content in this locale. An empty array means that no user will be allowed to create or change content in this locale.
  - namestringrequired
    Description
    The unique name of the user, role or application that this identifier references.
    Min Length
    1
    Max Length
    255
  - typestring
    Examples
    user
    role
    application
    Description
    The type of the security entity that this identifier references. Will default to 'role' if not specified.
    Max Length
    50
- createdstring<date-time>
  Description
  A timestamp indicating when this locale was first created.
  Format
  date-time
- createdBystring
  Description
  The username of the user that created this locale.
- lastModifiedstring<date-time>
  Format
  date-time
- lastModifiedBystring
  Description
  The username of the user that last modified this locale.
- fallbackstring
  Description
  A fallback locale that should be used if content is not available in the current locale.

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date
Locationstring
Description
Indicates the URL of the newly-created resource.
Preference-Applied

400Bad Request

401Unauthorized

403Forbidden

409Conflict

429Too Many Requests

ProblemDetails
- typestring<uri>
  Description
  A URI reference that identifies the problem type.
  Format
  uri
- titlestring
  Description
  A short, human-readable summary of the problem type.
- statusinteger<int32>
  Description
  The HTTP status code generated by the origin server for this occurrence of the problem.
  Format
  int32
  Minimum
  100
  Maximum
  599
- detailstring
  Description
  A human-readable explanation specific to this occurrence of the problem.
- instancestring<uri>
  Description
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  Format
  uri
- codestring
  Description
  Error code that identifies the problem type.
- errorsobject[]
  Description
  An array of error details with more detailed information about the problem.
  - detailstring
    Description
    A granular explanation of one specific error related to a field, header or query parameter.
  - fieldstring
    Example
    properties.header.displayName
    Description
    A string that may provide a hint to which field that was the source of the error.

Response Headers

Retry-Afternumber
Description
Indicates how long the client should wait before making a new request.

500Internal Server Error

curl

curl --request POST \
     --url https://api.cms.optimizely.com/v1/locales \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "key": "",
     "displayName": "",
     "routeSegment": "",
     "accessRights": [
     {
     "name": ""
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "key": "",
   "displayName": "",
   "routeSegment": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cms.optimizely.com/v1/locales", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cms.optimizely.com/v1/locales")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "key": "",
   "displayName": "",
   "routeSegment": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cms.optimizely.com/v1/locales"

payload = json.dumps({
   "key": "",
   "displayName": "",
   "routeSegment": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created
{
  "key": "",
  "displayName": "",
  "isEnabled": false,
  "routeSegment": "",
  "sortOrder": "",
  "accessRights": [
    {
      "name": "",
      "type": "user"
    }
  ],
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "fallback": ""
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

409

// Conflict

429

// Too Many Requests
{
  "type": "",
  "title": "",
  "status": "",
  "detail": "",
  "instance": "",
  "code": "",
  "errors": [
    {
      "detail": "",
      "field": "properties.header.displayName"
    }
  ]
}

500

// Internal Server Error