PUT /crm/v4/settings/user_groups/{user_group_id}

Update the details of a user group through this API. Use the boolean key "_delete" in the "sources" array, to remove a user from the group.

Servers

Path parameters

Name Type Required Description
user_group_id String Yes

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
user_groups[] Array No
user_groups[].sources[] Array No
user_groups[].sources[].source Object No
user_groups[].sources[].source.id String No
user_groups[].sources[].source.name String No
user_groups[].sources[].subordinates Boolean No
user_groups[].sources[]._delete Boolean No
user_groups[].sources[].type String No
user_groups[].name String No
user_groups[].description String No

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.