PIpipedrive
Roles

Add or update role setting

Changed on

Adds or updates the visibility setting for a role.

post/roles/{id}/settings

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: admin

Path parameters

idinteger required

The ID of the role

Request body

setting_key'deal_default_visibility' | 'lead_default_visibility' | 'org_default_visibility' | 'person_default_visibility' | 'product_default_visibility' required
value1 | 3 | 5 | 7 required

Possible values for the default_visibility setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Light / Growth and Professional plans</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>1</td><td>Owner & Followers</td></tr> <tr><td>3</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Premium / Ultimate plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>1</td><td>Owner only</td></tr> <tr><td>3</td><td>Owner's visibility group</td></tr> <tr><td>5</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>7</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.

Response

List role settings

successboolean

If the response is successful or not

Changes