Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Add or update role setting

Adds or updates the visibility setting for a role.

Input

type: object properties: parameters: type: object properties: id: type: integer description: The ID of the role required: - id data: title: addOrUpdateRoleSettingRequest type: object required: - setting_key - value properties: setting_key: type: string enum: - deal_default_visibility - lead_default_visibility - org_default_visibility - person_default_visibility - product_default_visibility value: type: integer enum: - 1 - 3 - 5 - 7 description: >- Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</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>Professional / Enterprise 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&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;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>.

Output

title: addOrUpdateRoleSettingResponse200 type: object properties: success: type: boolean description: If the response is successful or not data: type: object description: The response data properties: id: type: integer description: The ID of the role deal_default_visibility: type: number enum: - 1 - 3 - 5 - 7 description: The setting