Create Locale

curl --request POST \
  --url https://api.makeswift.com/v2/locales \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locale": "es-ES",
  "domain": "https://hearthfurniture.com.mx"
}
'

import requests

url = "https://api.makeswift.com/v2/locales"

payload = {
    "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locale": "es-ES",
    "domain": "https://hearthfurniture.com.mx"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    siteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    locale: 'es-ES',
    domain: 'https://hearthfurniture.com.mx'
  })
};

fetch('https://api.makeswift.com/v2/locales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.makeswift.com/v2/locales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'siteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'locale' => 'es-ES',
    'domain' => 'https://hearthfurniture.com.mx'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.makeswift.com/v2/locales"

	payload := strings.NewReader("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.makeswift.com/v2/locales")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v2/locales")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}"

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

{
  "object": "locale",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locale": "<string>",
  "domain": "https://hearthfurniture.com.mx",
  "isDefault": true
}

{
  "object": "error",
  "code": "bad_request",
  "message": "<string>"
}

{
  "object": "error",
  "code": "forbidden",
  "message": "<string>"
}

{
  "object": "error",
  "code": "not_found",
  "message": "<string>"
}

{
  "object": "error",
  "code": "conflict",
  "message": "<string>"
}

POST

locales

Create Locale

curl --request POST \
  --url https://api.makeswift.com/v2/locales \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locale": "es-ES",
  "domain": "https://hearthfurniture.com.mx"
}
'

import requests

url = "https://api.makeswift.com/v2/locales"

payload = {
    "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locale": "es-ES",
    "domain": "https://hearthfurniture.com.mx"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    siteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    locale: 'es-ES',
    domain: 'https://hearthfurniture.com.mx'
  })
};

fetch('https://api.makeswift.com/v2/locales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.makeswift.com/v2/locales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'siteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'locale' => 'es-ES',
    'domain' => 'https://hearthfurniture.com.mx'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.makeswift.com/v2/locales"

	payload := strings.NewReader("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.makeswift.com/v2/locales")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v2/locales")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locale\": \"es-ES\",\n  \"domain\": \"https://hearthfurniture.com.mx\"\n}"

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

{
  "object": "locale",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locale": "<string>",
  "domain": "https://hearthfurniture.com.mx",
  "isDefault": true
}

{
  "object": "error",
  "code": "bad_request",
  "message": "<string>"
}

{
  "object": "error",
  "code": "forbidden",
  "message": "<string>"
}

{
  "object": "error",
  "code": "not_found",
  "message": "<string>"
}

{
  "object": "error",
  "code": "conflict",
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

API key authentication. Accepts either:

App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Body

application/json

siteId

string<uuid>

required

The site ID to create the locale for.

locale

string

required

Locale of the site locale.

Example:

"es-ES"

domain

string<uri>

The domain URL for domain-based localization. This URL must include the protocol.

Example:

"https://hearthfurniture.com.mx"

Response

object

enum<string>

required

Available options:

locale

Example:

"locale"

string<uuid>

required

The ID of the created locale.

locale

string

required

We support the subset of locales specified with ISO 3166 that are composed of language and optionally a region.

Examples:

"en"

"es"

"fr-FR"

"ar-EG"

"ja-JP"

domain

string<uri> | null

required

The domain URL for domain-based localization.

Example:

"https://hearthfurniture.com.mx"

isDefault

boolean

required

The flag that indicates whether this locale is the default locale for the site.

Get started

Guides

Reference

Create Locale

Authorizations

Body

Response