SAsalesforce
collectorGroups

Update collector group (partial).

Changed on

Update the specified fields. If patching the list of collectors, it will replace the current list. It will update if all collectors named in the array aren't already assigned to a different group.

patch/collectorGroups/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/collectorGroups/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The name of the collector group.

Request body

descriptionstring

A description of the collector group.

namestring

A unique and descriptive name for the collector group.

collectorsstring[]

List of collectors for the group.

generatorsstring[]

List of generators assigned to this group.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns the updated collector group.

descriptionstring

A description of the collector group.

createdBystring

Id of the user who created the collector group.

idstring

The collector group id.

namestring

The collector group name.

collectorsobject[]

List of collectors for the group.

Changes