Skip to main content

RelationshipUpsertItemV2

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 object | null

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
typesstring[]required

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

Possible values: >= 1

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

Possible values: <= 500 characters

contacts object[]

Enter the email addresses of existing contacts to associate with this relationship. The emails must match contacts already stored in the organizations selected for the relationship.

  • Array [
    • emailemailrequired

    Email of an existing contact to associate with the relationship.

    Possible values: <= 255 characters

    Example: [email protected]
  • ]
    • RelationshipUpsertItemV2
    {
      "source": {
        "kind": "external",
        "value": "ID-123"
      },
      "target": {
        "kind": "external",
        "value": "LC-111"
      },
      "leadSupplier": "Unknown Type: object,null",
      "types": [
        "direct supplier"
      ],
      "relationshipStatus": "active",
      "customFields": {
        "custom1": "2025-01-01",
        "priority": "high",
        "notes": "Primary supplier relationship"
      },
      "contacts": [
        {
          "email": "[email protected]"
        }
      ]
    }