Skip to main content
POST
/
v1
/
asset_types
/
{assetTypeIdOrName}
/
properties
/
{propertyName}
Add Property to Asset Type
curl --request POST \
  --url https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/properties/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "required": true,
  "display_name": "<string>",
  "enum": [
    "<string>"
  ]
}
'
import requests

url = "https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/properties/{propertyName}"

payload = {
"name": "<string>",
"type": "<string>",
"required": True,
"display_name": "<string>",
"enum": ["<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>',
type: '<string>',
required: true,
display_name: '<string>',
enum: ['<string>']
})
};

fetch('https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/properties/{propertyName}', 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/asset_types/{assetTypeIdOrName}/properties/{propertyName}",
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>',
'type' => '<string>',
'required' => true,
'display_name' => '<string>',
'enum' => [
'<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/asset_types/{assetTypeIdOrName}/properties/{propertyName}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true,\n \"display_name\": \"<string>\",\n \"enum\": [\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/asset_types/{assetTypeIdOrName}/properties/{propertyName}")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true,\n \"display_name\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/properties/{propertyName}")

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 \"type\": \"<string>\",\n \"required\": true,\n \"display_name\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "display_name": "<string>",
  "required": true,
  "description": "<string>",
  "enum": [
    "<string>"
  ],
  "array": {
    "properties": [
      {
        "name": "<string>",
        "required": true,
        "description": "<string>",
        "enum": [
          "<string>"
        ]
      }
    ]
  },
  "file_rules": {
    "max_size": 123,
    "allowed_extensions": [
      "<string>"
    ],
    "allowed_mime_types": [
      "<string>"
    ]
  },
  "monitors": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "kind": "<string>",
      "enabled": true,
      "config": {}
    }
  ]
}
{
"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>"
}
{
"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

Path Parameters

assetTypeIdOrName
string
required

Asset type ID (UUID) or name (e.g., system.configuration)

propertyName
string
required

Property name

Body

application/json
name
string
required
type
string
required
required
boolean
display_name
string
enum
string[]

Response

Default Response

name
string
required

Property name

type
enum<string>
required

Property type

Available options:
string,
number,
integer,
boolean,
array,
secret,
totp,
file,
date,
datetime,
richtext,
richtext_large
display_name
string
required

Display name for UI

required
boolean
required

Whether this property is required

description
string

Property description

enum
(string | number | boolean)[]

Allowed values for this property

array
object

Array item configuration

file_rules
object

File validation rules

monitors
object[]

Monitors targeting this property (only present when expand=monitors)