Add Custom Object Relationship

curl --request PUT \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/{objectId}/relationships/{fieldRefId}/{targetId} \
  --header 'Authorization: <api-key>'

{
  "objectId": "550e8400-e29b-41d4-a716-446655440020",
  "fieldRefId": "ownerExposure",
  "targetId": "550e8400-e29b-41d4-a716-446655440200",
  "created": true
}

Custom Objects

Add Custom Object Relationship

Links a custom object to a target entity via a relationship field. Use the fieldRefId from the Get Configuration endpoint.

Cardinality behavior:

one_to_one: Replaces any existing link from this object and any existing link to the target. Each side can have at most one link.
one_to_many: Replaces any existing link from this object (the “one” side), but the target (the “many” side) can have multiple links.
many_to_one: Appends the link. The source (the “many” side) can have multiple links, but existing links to the target from other sources on the “one” side are replaced.
many_to_many: Appends the link. Both sides can have multiple links.

If the exact same link already exists, the operation is idempotent and returns created: false.

Required permission: company.fmv1_custom_object:update

PUT

api

external

companies

{companyId}

custom-objects

{objectType}

{objectId}

relationships

{fieldRefId}

{targetId}

Add Custom Object Relationship

curl --request PUT \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/{objectId}/relationships/{fieldRefId}/{targetId} \
  --header 'Authorization: <api-key>'

{
  "objectId": "550e8400-e29b-41d4-a716-446655440020",
  "fieldRefId": "ownerExposure",
  "targetId": "550e8400-e29b-41d4-a716-446655440200",
  "created": true
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId

string<uuid>

required

Company identifier

objectType

string

required

Custom object type in snake_case format (e.g., vehicle, building_info)

objectId

string<uuid>

required

Custom object identifier

fieldRefId

string

required

Relationship field reference ID from the configuration endpoint

targetId

string<uuid>

required

Target custom object identifier to link or unlink

Response

Relationship added (or already existed)

objectId

string<uuid>

The source custom object ID

fieldRefId

string

The relationship field reference ID

targetId

string<uuid>

The target entity ID

created

boolean

true if a new link was created, false if the exact link already existed.

Delete Custom Object Remove Custom Object Relationship

⌘I