RelationshipUpsertRequest

relationships object[]required

Array of relationship objects to create, update, or remove

Possible values: >= 1, <= 100

Array [

source objectrequired

The originating organization of the relationship. Identified using either an internal ID or an external ID

kindstringrequired

The type of identifier used for the source organization

Possible values: [internal, external]

Default value: internal

Example: external

valuestringrequired

The ID value of the source organization

Possible values: <= 100 characters

Example: ID-123

target objectrequired

The receiving organization of the relationship. Identified using either an internal ID or an external ID

kindstringrequired

The type of identifier used for the target organization

Possible values: [internal, external]

Default value: internal

Example: external

valuestringrequired

The ID value of the target organization

Possible values: <= 100 characters

Example: LC-111

typestringrequired

Defines the relationship type between the organizations. Values must match one of the available relationship types. Refer to the List Relationship Types endpoint to retrieve the full list of supported values

Possible values: <= 100 characters

Example: direct supplier

customFields object

Key-value pairs for relationship-specific data fields

property name*string

]

RelationshipUpsertRequest

{
  "relationships": [
    {
      "source": {
        "kind": "external",
        "value": "ID-123"
      },
      "target": {
        "kind": "external",
        "value": "LC-111"
      },
      "type": "direct supplier",
      "customFields": {
        "custom1": "2025-01-01"
      }
    },
    {
      "source": {
        "kind": "internal",
        "value": "456"
      },
      "target": {
        "kind": "internal",
        "value": "789"
      },
      "type": "customer"
    }
  ]
}