SugarCRM SupportProduct GuidesSugar DeveloperSugar Developer Guide 9.2IntegrationWeb ServicesREST APIEndpoints/<module>/MassUpdate PUT
This release is only available for SugarCloud customers.

/<module>/MassUpdate PUT

Overview

An API to mass update records.

Query String Parameters

Name Type Description Required
massupdate_params Array Mass update parameters. True
massupdate_params.uid Array A list of ids. True
massupdate_params.[field name] [field type] The field to be modified. False
massupdate_params.team_name Array Team array. False
massupdate_params.team_name_type String Whether to replace or add teams. Possible values are 'add' and 'replace'. False

Request

Mass Updating Records by ID in a Module

{
    "massupdate_params":{
        "uid":[
            "f22d1955-97d8-387d-9866-512d09cc1520",
            "ef1b40aa-5815-4f8d-e909-512d09617ac8"
        ],
        "department":"Marketing"
    }
}

Mass Updating Records with Teams

{
   "massupdate_params":{
      "uid":[
         "f22d1955-97d8-387d-9866-512d09cc1520",
         "ef1b40aa-5815-4f8d-e909-512d09617ac8"
      ],
      "team_name":[
         {
            "id":"35eab226-c20d-48f4-4670-512d095c8c6f",
            "primary":true
         },
         {
            "id":"8f640aba-f356-7374-7eb4-512d09745551",
            "primary":false
         }
      ],
      "team_name_type":"replace"
   }
}

Mass Add Leads, Contacts or Prospects to a Target List

{
    "massupdate_params": {
        "uid": [     /* Leads, Contacts, or Prospects to Add */
            "f3d90a49-14b4-a81c-6cac-526e6c71d33e",
            "f22cde0d-9a20-89d3-ca14-526e6c3c4d08",
            "f15f10bd-1445-5e20-9b5c-526e6ceb71d0"
        ],
        "prospect_lists": [
                 /* Prospect List(s) to Add them To */
            "bc5bc249-9c9c-52ad-52b9-526e71f0e18d"
        ]
    }
}

Response Arguments

Name Type Description
Status String The status of the mass update. Possible value is 'done'.

Output Done Example

{
    "status":"done"
}

Change Log

Version Change
v10 Added /<module>/MassUpdate PUT endpoint.

Last modified: 2019-10-03 21:35:41