Create Page

Create Page

curl --request POST \
  --url https://api.makeswift.com/v6/pages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "<string>",
  "name": "<string>"
}
'

import requests

url = "https://api.makeswift.com/v6/pages"

payload = {
    "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pathname": "<string>",
    "name": "<string>"
}
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',
    pathname: '<string>',
    name: '<string>'
  })
};

fetch('https://api.makeswift.com/v6/pages', 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/v6/pages",
  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',
    'pathname' => '<string>',
    'name' => '<string>'
  ]),
  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/v6/pages"

	payload := strings.NewReader("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\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/v6/pages")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v6/pages")

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  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{
  "object": "page",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "furniture",
  "canonicalUrl": "<string>",
  "title": "<string>",
  "description": "<string>",
  "socialImageUrl": "<string>",
  "sitemapPriority": 0.5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "isOnline": true,
  "excludedFromSearchEngines": true,
  "localizations": [
    {
      "pathname": "<string>",
      "locale": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "locale": "<string>"
}

POST

pages

Create Page

curl --request POST \
  --url https://api.makeswift.com/v6/pages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "<string>",
  "name": "<string>"
}
'

import requests

url = "https://api.makeswift.com/v6/pages"

payload = {
    "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pathname": "<string>",
    "name": "<string>"
}
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',
    pathname: '<string>',
    name: '<string>'
  })
};

fetch('https://api.makeswift.com/v6/pages', 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/v6/pages",
  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',
    'pathname' => '<string>',
    'name' => '<string>'
  ]),
  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/v6/pages"

	payload := strings.NewReader("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\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/v6/pages")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v6/pages")

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  \"pathname\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{
  "object": "page",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "furniture",
  "canonicalUrl": "<string>",
  "title": "<string>",
  "description": "<string>",
  "socialImageUrl": "<string>",
  "sitemapPriority": 0.5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "isOnline": true,
  "excludedFromSearchEngines": true,
  "localizations": [
    {
      "pathname": "<string>",
      "locale": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "locale": "<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 page for.

pathname

string

required

The page pathname.

name

string

required

The page name.

Minimum string length: 1

Response

object

enum<string>

required

Available options:

page

Example:

"page"

string<uuid>

required

The ID of the page.

pathname

string

required

The page pathname.

Example:

"furniture"

canonicalUrl

string | null

required

The canonical URL of the page.

title

string | null

required

The page title.

description

string | null

required

The page description.

The social image URL of the page.

sitemapPriority

number | null

required

The sitemap priority.

Required range: 0 <= x <= 1

sitemapFrequency

enum<string> | null

required

The sitemap update frequency.

Available options:

always,

hourly,

daily,

weekly,

monthly,

yearly,

never

createdAt

string<date-time> | null

required

The page creation date and time.

updatedAt

string<date-time> | null

required

The page last update date and time.

publishedAt

string<date-time> | null

required

The page publication date and time.

isOnline

boolean

required

The flag that indicates whether the page is online.

excludedFromSearchEngines

boolean | null

required

The flag that indicates whether the page is excluded from search.

localizations

object[]

required

The localizations of the page.

Show child attributes

locale

string

The page locale. This defaults to the default locale of the parent site.

Get started

Guides

Reference

Authorizations

Body

Response