Skip to main content
POST
/
v1
/
locations
/
{id}
/
lines
Create a line
curl --request POST \
  --url https://api.qminder.com/v1/locations/{id}/lines \
  --header 'Content-Type: application/json' \
  --header 'X-Qminder-API-Version: <x-qminder-api-version>' \
  --header 'X-Qminder-REST-API-Key: <api-key>' \
  --data '
{
  "name": "Customer Support",
  "color": "TEAL",
  "translations": [
    {
      "languageCode": "fr",
      "name": "Service client"
    }
  ],
  "appointmentSettings": {
    "enabled": true,
    "duration": 30
  }
}
'
import requests

url = "https://api.qminder.com/v1/locations/{id}/lines"

payload = {
"name": "Customer Support",
"color": "TEAL",
"translations": [
{
"languageCode": "fr",
"name": "Service client"
}
],
"appointmentSettings": {
"enabled": True,
"duration": 30
}
}
headers = {
"X-Qminder-API-Version": "<x-qminder-api-version>",
"X-Qminder-REST-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-Qminder-API-Version': '<x-qminder-api-version>',
'X-Qminder-REST-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Customer Support',
color: 'TEAL',
translations: [{languageCode: 'fr', name: 'Service client'}],
appointmentSettings: {enabled: true, duration: 30}
})
};

fetch('https://api.qminder.com/v1/locations/{id}/lines', 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.qminder.com/v1/locations/{id}/lines",
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([
'name' => 'Customer Support',
'color' => 'TEAL',
'translations' => [
[
'languageCode' => 'fr',
'name' => 'Service client'
]
],
'appointmentSettings' => [
'enabled' => true,
'duration' => 30
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Qminder-API-Version: <x-qminder-api-version>",
"X-Qminder-REST-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.qminder.com/v1/locations/{id}/lines"

payload := strings.NewReader("{\n \"name\": \"Customer Support\",\n \"color\": \"TEAL\",\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"name\": \"Service client\"\n }\n ],\n \"appointmentSettings\": {\n \"enabled\": true,\n \"duration\": 30\n }\n}")

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

req.Header.Add("X-Qminder-API-Version", "<x-qminder-api-version>")
req.Header.Add("X-Qminder-REST-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.qminder.com/v1/locations/{id}/lines")
.header("X-Qminder-API-Version", "<x-qminder-api-version>")
.header("X-Qminder-REST-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Customer Support\",\n \"color\": \"TEAL\",\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"name\": \"Service client\"\n }\n ],\n \"appointmentSettings\": {\n \"enabled\": true,\n \"duration\": 30\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qminder.com/v1/locations/{id}/lines")

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

request = Net::HTTP::Post.new(url)
request["X-Qminder-API-Version"] = '<x-qminder-api-version>'
request["X-Qminder-REST-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Customer Support\",\n \"color\": \"TEAL\",\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"name\": \"Service client\"\n }\n ],\n \"appointmentSettings\": {\n \"enabled\": true,\n \"duration\": 30\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "12345"
}

Authorizations

X-Qminder-REST-API-Key
string
header
default:yourbusinessapikey
required

Headers

X-Qminder-API-Version
enum<string>
default:2020-09-01
required

API version. Must be set to 2020-09-01.

Available options:
2020-09-01

Path Parameters

id
integer<int32>
default:123
required

ID of a Location

Body

application/json
name
string
required

Line name (max 30 characters).

Maximum string length: 30
color
enum<string>
required

Line color.

Available options:
VIOLET,
LAVENDER,
MARSHMALLOW,
TEAL,
MINT,
CORAL,
YELLOW,
ROSE,
INDIGO,
BLUE
disabled
boolean

Whether the line starts disabled. Default: false.

translations
object[]

Name translations for multi-language support.

appointmentSettings
object

Appointment configuration for this line.

Response

Line created successfully

id
string

The ID of the created line.

Example:

"12345"