Modify company relations incrementally

Create or update a relationship

If you omit the name property for the company, then only the nested properties are synced. In the following example, on the the parentCompanies will be synced since the name of the company is not specified.

PUT /api/v1/sync
Authorization: Bearer :token
Content-Type: application/json
{
  "companies": [
    {
      "referenceId": "d",
      "parentCompanies": [
        {
          "referenceId": "b",
          "ownership": 25
        }
      ]
    }
  ]
}

How to delete a relationship?

Previously created relations are not deleted by default. In order to delete relationships, use the delete property.

PUT /api/v1/sync
Authorization: Bearer :token
Content-Type: application/json
{
  "companies": [
    {
      "referenceId": "d",
      "parentCompanies": [
        {
          "referenceId": "b",
          "ownership": 25,
          "delete": true        <--- Set the `delete` property to `true`
        }
      ]
    }
  ]
}

How to delete all previously created relationships?

In order to delete all previously created relationships, set the value of the cleanup property to true

PUT /api/v1/sync
Authorization: Bearer :token
Content-Type: application/json
{
  "config": {
    "cleanup": true
  },
  "companies": [
    {
      "referenceId": "d",
      "parentCompanies": [
        {
          "referenceId": "b",
          "ownership": 25
        }
      ]
    }
  ]
}