Create Route

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

import requests

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

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

fetch('https://api.makeswift.com/v2/routes', 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/routes",
  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' => '/furniture'
  ]),
  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/routes"

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

require 'uri'
require 'net/http'

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

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\": \"/furniture\"\n}"

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

{
  "object": "route",
  "id": "37b18c41-9752-4adf-9aef-f42ab4f74b04",
  "pathname": "/furniture"
}

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

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

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

POST

routes

Create Route

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

import requests

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

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

fetch('https://api.makeswift.com/v2/routes', 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/routes",
  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' => '/furniture'
  ]),
  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/routes"

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

require 'uri'
require 'net/http'

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

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\": \"/furniture\"\n}"

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

{
  "object": "route",
  "id": "37b18c41-9752-4adf-9aef-f42ab4f74b04",
  "pathname": "/furniture"
}

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

{
  "object": "error",
  "code": "forbidden",
  "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)

Query Parameters

skipValidation

enum<string>

The flag that determines whether to skip route validation. Useful when an external system has a different way of validating routes than Makeswift.

Available options:

true,

false

Body

application/json

The request body for creating a new route.

siteId

string<uuid>

required

The site ID to create the route for.

pathname

string

required

The route pathname.

Example:

"/furniture"

Response

The route.

object

enum<string>

required

Available options:

route

string<uuid>

required

The ID of the route.

pathname

string

required

The route pathname.

Example:

"/furniture"

Get started

Guides

Reference

Create Route

Authorizations

Query Parameters

Body

Response