New field in the API response of the related_objects object

What is going to change?

We have added a new field owner_id to the person object of the related_objects in the API response. This field shows the owner ID of the user who owns the Person record. The value of the field is always an integer.

Here’s the code example of the new response in JSON:

{
  "data": [...],
  "additional_data": {...},
  "related_objects": {
    "person": {
      "1": {
        "id": 1,
        "name": "person name",
        "active_flag": true,
        "email": [
          {
            "label": "work",
            "value": "[email protected]",
            "primary": true
          }
        ],
        "phone": [
          {
            "label": "work",
            "value": "5555555",
            "primary": true
          }
        ],
        "owner_id": 1111111
      }
    }
  }
}
}

Why is it added?

In addition to fixing a bug in our web app, this update will also bring more consistency to our API as the field owner_id is currently present only in the organization object of the related_objects.

Who is affected?

Users who are referring to the person object of the related_objects in webhooks and when using the following 15 API endpoints:

• GET /v1/activities
• GET /v1/activities/{id}
• POST /v1/activities
• PUT /v1/activities/{id}
• GET /v1/deals
• GET /v1/deals/{id}
• GET /v1/deals/{id}/activities
• GET /v1/deals/{id}/flow
• GET /v1/deals/{id}/participants
• POST /v1/deals
• POST /v1/deals/{id}/participants
• PUT /v1/deals/{id}
• GET /v1/organizations/{id}/deals
• GET /v1/persons/{id}/deals
• GET /v1/persons/{id}/flow

      <br>
  <p class="published-on"><i>Published on June 3, 2021</i></p>