POST /roles/{id}/settings

Adds or updates the visibility setting for a role.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The ID of the role

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
setting_key String Yes

Possible values:

  • "deal_default_visibility"
  • "org_default_visibility"
  • "person_default_visibility"
  • "lead_default_visibility"
  • "product_default_visibility"
value Integer Yes

Possible values for the default_visibility setting depending on the subscription plan:

Essential / Advanced plan
ValueDescription
1Owner & Followers
3Entire company

Professional / Enterprise plan
ValueDescription
1Owner only
3Owner's visibility group
5Owner's visibility group and sub-groups
7Entire company

Read more about visibility groups here.

Possible values:

  • 1
  • 3
  • 5
  • 7

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.