Create a folder
curl --request POST \
--url https://biq.li/api/v1/folder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"rotator": true,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": true,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"exp_clicks_rule": {
"key": 2,
"value": "<string>"
},
"tag_ids": [
"<string>"
],
"pixel_ids": [
"<string>"
]
}
'import requests
url = "https://biq.li/api/v1/folder"
payload = {
"name": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": True,
"rotator": True,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": True,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"exp_clicks_rule": {
"key": 2,
"value": "<string>"
},
"tag_ids": ["<string>"],
"pixel_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alias: '<string>',
domain_id: '<string>',
active: true,
rotator: true,
password: '<string>',
activates_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
utm: '<string>',
allow_search_engine_indexing: true,
geo_rules: [{key: '<string>', value: '<string>'}],
device_rules: [{key: '<string>', value: '<string>'}],
platform_rules: [{key: '<string>', value: '<string>'}],
exp_clicks_rule: {key: 2, value: '<string>'},
tag_ids: ['<string>'],
pixel_ids: ['<string>']
})
};
fetch('https://biq.li/api/v1/folder', 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://biq.li/api/v1/folder",
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' => '<string>',
'description' => '<string>',
'alias' => '<string>',
'domain_id' => '<string>',
'active' => true,
'rotator' => true,
'password' => '<string>',
'activates_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'utm' => '<string>',
'allow_search_engine_indexing' => true,
'geo_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'device_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'platform_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'exp_clicks_rule' => [
'key' => 2,
'value' => '<string>'
],
'tag_ids' => [
'<string>'
],
'pixel_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://biq.li/api/v1/folder"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://biq.li/api/v1/folder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/folder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"folder": {
"id": "<string>",
"name": "<string>",
"short_url": "<string>",
"alias": "<string>",
"active": true,
"rotator": true,
"has_password": true,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"tag_ids": [
"<string>"
],
"pixel_ids": [
"<string>"
],
"links_count": 1,
"clicks_count": 1,
"description": "<string>",
"domain_id": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": true,
"exp_clicks_rule": {},
"clicked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"status": "success"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}Folders
Create a folder
Create a workspace folder and configure its public short URL.
POST
/
v1
/
folder
Create a folder
curl --request POST \
--url https://biq.li/api/v1/folder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"rotator": true,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": true,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"exp_clicks_rule": {
"key": 2,
"value": "<string>"
},
"tag_ids": [
"<string>"
],
"pixel_ids": [
"<string>"
]
}
'import requests
url = "https://biq.li/api/v1/folder"
payload = {
"name": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": True,
"rotator": True,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": True,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"exp_clicks_rule": {
"key": 2,
"value": "<string>"
},
"tag_ids": ["<string>"],
"pixel_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alias: '<string>',
domain_id: '<string>',
active: true,
rotator: true,
password: '<string>',
activates_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
utm: '<string>',
allow_search_engine_indexing: true,
geo_rules: [{key: '<string>', value: '<string>'}],
device_rules: [{key: '<string>', value: '<string>'}],
platform_rules: [{key: '<string>', value: '<string>'}],
exp_clicks_rule: {key: 2, value: '<string>'},
tag_ids: ['<string>'],
pixel_ids: ['<string>']
})
};
fetch('https://biq.li/api/v1/folder', 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://biq.li/api/v1/folder",
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' => '<string>',
'description' => '<string>',
'alias' => '<string>',
'domain_id' => '<string>',
'active' => true,
'rotator' => true,
'password' => '<string>',
'activates_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'utm' => '<string>',
'allow_search_engine_indexing' => true,
'geo_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'device_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'platform_rules' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'exp_clicks_rule' => [
'key' => 2,
'value' => '<string>'
],
'tag_ids' => [
'<string>'
],
'pixel_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://biq.li/api/v1/folder"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://biq.li/api/v1/folder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/folder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"rotator\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"utm\": \"<string>\",\n \"allow_search_engine_indexing\": true,\n \"geo_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"device_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"platform_rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"exp_clicks_rule\": {\n \"key\": 2,\n \"value\": \"<string>\"\n },\n \"tag_ids\": [\n \"<string>\"\n ],\n \"pixel_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"folder": {
"id": "<string>",
"name": "<string>",
"short_url": "<string>",
"alias": "<string>",
"active": true,
"rotator": true,
"has_password": true,
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"tag_ids": [
"<string>"
],
"pixel_ids": [
"<string>"
],
"links_count": 1,
"clicks_count": 1,
"description": "<string>",
"domain_id": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"utm": "<string>",
"allow_search_engine_indexing": true,
"exp_clicks_rule": {},
"clicked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"status": "success"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}POST /v1/folder requires Folders: Write (link_groups.create). The API key determines the workspace.
curl -X POST https://biq.li/api/v1/folder \
-H 'Authorization: Bearer biqli_your_workspace_api_key' \
-H 'Content-Type: application/json' \
-d '{"name":"Summer campaign","alias":"summer"}'
name is required. Optional fields are description, alias, domain_id, active, rotator, password, activates_at, expires_at, utm, allow_search_engine_indexing, geo_rules, device_rules, platform_rules, exp_clicks_rule, tag_ids, and pixel_ids. Resource references use biq_dom_, biq_tag_, and biq_pxl_ public IDs from this workspace. Alias rules and workspace plan restrictions also apply.
Using domain_id, tag_ids, or pixel_ids additionally requires custom_domains.view, tags.view, or tracking_pixels.view, respectively.
The response is 201 Created with { "folder": { ... }, "status": "success" }. The folder has a biq_fld_... ID and includes its short URL, configuration, public attachment IDs, link/click counts, and timestamps. Passwords are never returned; has_password reports whether one is configured.
Duplicate names return 409 folder_name_taken; an occupied alias returns 409 alias_taken. Unknown fields return 422 validation_error.
Shared API behavior
Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.Authorizations
A workspace API key beginning with biqli_.
Body
application/json
Required string length:
3 - 250Maximum string length:
250Pattern:
^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$Maximum string length:
250Maximum string length:
2000Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
100Maximum array length:
100