New field lead_default_visibility in the Roles API

Users already had control over the default visibility for other entities (Organizations, People, Deals and Products). Now, the Users can also define the default visibility for their leads.

What has been added to the Roles API?

In order for our Users to be able to define the default visibility for their leads also via the API, we have extended the responses of three Roles’ endpoints.

The possible values for the lead_default_visibility field depend on the plan the company using the Roles API is on:

Essential / Advanced plan:

• 1 (Owner & followers)
• 3 (Entire company)

Professional / Enterprise plan:

• 1 (Owner & followers)
• 3 (Owners visibility group)
• 5 (Owners visibility group and below)
• 7 (Entire company)

Which Roles API endpoints are affected?

1. GET /v1/roles/{id}/settings - we updated the response to include lead_default_visibility, so now this endpoint will always return:

{
 "success": true,
 "data": {
  (...)
  "lead_default_visibility": 1
 }
}

2. POST /v1/roles/{id}/settings - the request can include and return the field lead_default_visibility in the body (if updating the lead visibility)

{
 "success": true,
 "data": {
  "id": 2,
  "lead_default_visibility": 1
 }
}

3. GET /v1/roles/{id} - we updated the response to include lead_default_visibility, so now this endpoint will always return

{
 "success": true,
 "data": { ... },
 "additional_data": {
  "settings": {
   (...)
   "lead_default_visibility": 1
  }
 }
}

Published on June 3, 2021