Skip to main content
POST
/
v1
/
entity_types
/
{entityTypeIdOrName}
/
references
/
{referenceName}
Add Reference to Entity Type
curl --request POST \
  --url https://api.us.lexful.app/v1/entity_types/{entityTypeIdOrName}/references/{referenceName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "name": "<string>",
  "target_entity_types": [
    "<string>"
  ],
  "display_name": "<string>",
  "required": true,
  "multiple": true
}
'
{
  "name": "<string>",
  "display_name": "<string>",
  "required": true,
  "multiple": true,
  "description": "<string>",
  "target_entity_types": [
    "<string>"
  ],
  "validation_rules": {
    "min_count": 1,
    "max_count": 2,
    "bidirectional": true,
    "cascade_delete": true
  }
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

entityTypeIdOrName
string
required

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

referenceName
string
required

Reference name

Body

application/json
name
string
required
target_entity_types
string[]
required
display_name
string
required
boolean
multiple
boolean

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_entity_types
string[]

Target entity type names

validation_rules
object