Relationships

Create a relationship instance

Changed on

Creates a relationship instance between two records

post/v1/records/{record_id}/relationships

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Path parameters

record_idinteger required

Record ID

Request body

definition_idstring required

Relationship definition ID

entity_1_idstring required

First record ID

entity_2_idstring required

Second record ID

Example request

{
  "definition_id": "789",
  "entity_1_id": "1001",
  "entity_2_id": "2002"
}

Response

Created relationship instance

idstring
definition_idstring
entity_1_idstring
entity_2_idstring
created_atstring date-time

Example response

{
  "id": "5001",
  "definition_id": "789",
  "entity_1_id": "1001",
  "entity_2_id": "2002",
  "created_at": "2024-01-15T10:00:00Z"
}

Changes