Skip to main content
POST
/
v1
/
tags
Create Tag
curl --request POST \
  --url https://api.us.lexful.app/v1/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "color": "<string>",
  "asset_types": [
    "<string>"
  ]
}
'
import requests

url = "https://api.us.lexful.app/v1/tags"

payload = {
    "name": "<string>",
    "description": "<string>",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "color": "<string>",
    "asset_types": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Account-ID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Account-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    color: '<string>',
    asset_types: ['<string>']
  })
};

fetch('https://api.us.lexful.app/v1/tags', 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.us.lexful.app/v1/tags",
  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>',
    'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'color' => '<string>',
    'asset_types' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-ID: <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.us.lexful.app/v1/tags"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"asset_types\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Account-ID", "<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.us.lexful.app/v1/tags")
  .header("Authorization", "Bearer <token>")
  .header("X-Account-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"asset_types\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/tags")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"color\": \"<string>\",\n  \"asset_types\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_system": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "color": "<string>",
  "restricted": true,
  "asset_types": [
    "<string>"
  ],
  "deleted_at": "2023-11-07T05:31:56Z"
}
{
  "status": 123,
  "message": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "developer_message": "<string>"
}
{
  "status": 123,
  "message": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "developer_message": "<string>"
}
{
  "status": 123,
  "message": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Body

application/json
name
string
required

Tag name

Required string length: 1 - 100
description
string

Optional description for the tag

Maximum string length: 500
parent_id
string<uuid>

Optional parent tag ID for hierarchical tags (creates a child tag)

color
string

Hex color code (e.g., #FF5733)

Pattern: ^#[0-9A-Fa-f]{6}$
asset_types
string[]

Asset type names this tag is constrained to (omit or empty = applies to all)

Response

Default Response

id
string<uuid>
required

Tag unique identifier

name
string
required

Tag name

is_system
boolean
required

Whether this is a system-managed tag

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

created_by
string<uuid>
required

User ID who created the tag

updated_by
string<uuid>
required

User ID who last updated the tag

description
string | null

Optional description for the tag

parent_id
string<uuid> | null

Parent tag ID (null for root tags)

color
string | null

Hex color code (e.g., #FF5733)

Pattern: ^#[0-9A-Fa-f]{6}$
restricted
boolean

When true, only users/groups in the tag access grants can see assets carrying this tag

asset_types
string[]

Asset type names this tag is constrained to (empty = applies to all)

deleted_at
string<date-time> | null

Deletion timestamp (soft delete)