Skip to main content
PATCH
/
v1
/
asset_types
/
{assetTypeIdOrName}
/
references
/
{referenceName}
Update Reference on Asset Type
curl --request PATCH \
  --url https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/references/{referenceName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "required": true,
  "multiple": true,
  "target_asset_types": [
    "<string>"
  ]
}
'
import requests

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

payload = {
    "display_name": "<string>",
    "required": True,
    "multiple": True,
    "target_asset_types": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Account-ID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Account-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    display_name: '<string>',
    required: true,
    multiple: true,
    target_asset_types: ['<string>']
  })
};

fetch('https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/references/{referenceName}', 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}/references/{referenceName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'display_name' => '<string>',
    'required' => true,
    'multiple' => true,
    'target_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/asset_types/{assetTypeIdOrName}/references/{referenceName}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"required\": true,\n  \"multiple\": true,\n  \"target_asset_types\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.us.lexful.app/v1/asset_types/{assetTypeIdOrName}/references/{referenceName}")
  .header("Authorization", "Bearer <token>")
  .header("X-Account-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"required\": true,\n  \"multiple\": true,\n  \"target_asset_types\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"required\": true,\n  \"multiple\": true,\n  \"target_asset_types\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "display_name": "<string>",
  "required": true,
  "multiple": true,
  "description": "<string>",
  "target_asset_types": [
    "<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>"
}
{
  "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)

referenceName
string
required

Reference name

Body

application/json
display_name
string
required
boolean
multiple
boolean
target_asset_types
string[]

Response

Default Response

name
string
required

Reference name

display_name
string
required

Display name for UI

required
boolean
required

Whether this reference is required

multiple
boolean
required

Whether multiple references are allowed

description
string

Reference description

target_asset_types
string[]

Target asset type names