Skip to main content
POST
/
api
/
v1
/
collections
create collection
curl --request POST \
  --url https://{defaultHost}/api/v1/collections \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "collection": {
    "title": "<string>",
    "description": "<string>",
    "share_preference": "<string>",
    "pinned": true,
    "visual_order": 123,
    "emoji": "<string>",
    "public_visible": true,
    "share_all_links": true,
    "parent_id": 123,
    "cover_image_data": {
      "data": "<string>"
    }
  }
}
'
import requests

url = "https://{defaultHost}/api/v1/collections"

payload = { "collection": {
"title": "<string>",
"description": "<string>",
"share_preference": "<string>",
"pinned": True,
"visual_order": 123,
"emoji": "<string>",
"public_visible": True,
"share_all_links": True,
"parent_id": 123,
"cover_image_data": { "data": "<string>" }
} }
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
collection: {
title: '<string>',
description: '<string>',
share_preference: '<string>',
pinned: true,
visual_order: 123,
emoji: '<string>',
public_visible: true,
share_all_links: true,
parent_id: 123,
cover_image_data: {data: '<string>'}
}
})
};

fetch('https://{defaultHost}/api/v1/collections', 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://{defaultHost}/api/v1/collections",
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([
'collection' => [
'title' => '<string>',
'description' => '<string>',
'share_preference' => '<string>',
'pinned' => true,
'visual_order' => 123,
'emoji' => '<string>',
'public_visible' => true,
'share_all_links' => true,
'parent_id' => 123,
'cover_image_data' => [
'data' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <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://{defaultHost}/api/v1/collections"

payload := strings.NewReader("{\n \"collection\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"share_preference\": \"<string>\",\n \"pinned\": true,\n \"visual_order\": 123,\n \"emoji\": \"<string>\",\n \"public_visible\": true,\n \"share_all_links\": true,\n \"parent_id\": 123,\n \"cover_image_data\": {\n \"data\": \"<string>\"\n }\n }\n}")

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

req.Header.Add("X-Authorization", "<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://{defaultHost}/api/v1/collections")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"collection\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"share_preference\": \"<string>\",\n \"pinned\": true,\n \"visual_order\": 123,\n \"emoji\": \"<string>\",\n \"public_visible\": true,\n \"share_all_links\": true,\n \"parent_id\": 123,\n \"cover_image_data\": {\n \"data\": \"<string>\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/api/v1/collections")

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

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"collection\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"share_preference\": \"<string>\",\n \"pinned\": true,\n \"visual_order\": 123,\n \"emoji\": \"<string>\",\n \"public_visible\": true,\n \"share_all_links\": true,\n \"parent_id\": 123,\n \"cover_image_data\": {\n \"data\": \"<string>\"\n }\n }\n}"

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

Authorizations

X-Authorization
string
header
required

Body

application/json
collection
object
required

Response

200

successful