Skip to main content

RelationshipUpsertItem

source objectrequired

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

kindstringrequired

Type of identifier used

  • internal - Internal system ID
  • external - External/customer-defined ID

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

Type of identifier used

  • internal - Internal system ID
  • external - External/customer-defined ID

Possible values: [internal, external]

Default value: internal
Example: external
valuestringrequired

The ID value of the target organization

Possible values: <= 100 characters

Example: LC-111
leadSupplier objectnull

Represents the designated lead supplier within the relationship. This organization typically takes primary responsibility in managing the relationship or coordinating activities across related organizations.

kindstringrequired

Specifies whether the ID is internal (system-generated) or external (provided by the API consumer).

  • internal - Internal system ID
  • external - External/customer-defined ID

Possible values: [internal, external]

Example: external
valuestringrequired

The ID of the lead supplier organization, based on the selected kind.

Possible values: <= 100 characters

Example: ID-123
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
relationshipStatusstringrequired

Indicates the current status of the supplier relationship.

Possible values: [active, inactive]

Example: active
customFields object

Key-value pairs for relationship-specific data fields

property name*string
RelationshipUpsertItem
{
  "source": {
    "kind": "external",
    "value": "ID-123"
  },
  "target": {
    "kind": "external",
    "value": "LC-111"
  },
  "leadSupplier": "Unknown Type: object,null",
  "type": "direct supplier",
  "relationshipStatus": "active",
  "customFields": {
    "custom1": "2025-01-01",
    "priority": "high",
    "notes": "Primary supplier relationship"
  }
}