Mass update records

POST/{module}/actions/mass_update

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Mass update records action (under Records).
Fill in the fields below, then reference the result from later steps as {{massUpdateRecords.response.data}}.

Request

Path parameters

modulestringrequired

Specify the API name of the CRM module on which the mass update operation must be performed. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to fetch the valid API name of the module.

One ofLeadsAccountsContactsDealsCampaignsTasksCallsMeetingsCasesSolutionsProductsVendorsPrice_BooksQuotesSales_OrdersPurchase_OrdersInvoicesCustom

Request body

Enter the body as JSON in the step's Body field.

dataarray<object>required

Specify the array of objects, where each object maps a field's API name to the new value to be applied across the targeted records. The key must be provided along with either `ids` or `cvid`.

idsarray<string (int64)>

Specify the record IDs to be mass updated synchronously. Use `ids` for non-scheduler updates that target a small batch of records and require immediate processing. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get the valid IDs of the required records. > **Note**: > - You can use either **ids** key or the **cvid** key, you cannot use them both in a request. > - Scheduler type(using record IDs): > - You can mass update a maximum of 50,000 records in a single API call. > - Automation rules are triggered automatically when the record count is less than 1000. When the record count is greater than 1000, automation rules do not get triggered. > - If some of the records have invalid data, only those records will not be processed in the API call. > - Non-scheduler type(using CVID and territory ID): > - You can mass update a maximum of 500 records in a single API call. > - Automation rules such as approvals, blueprints, and workflows are triggered automatically. > - When you want to mass update records in a territory, you must specify the custom view ID. > - You cannot mass update Email, lookup fields, layout fields, multi-line fields, and line items. > - You can mass update up to three fields in the Deals module and only one field in all other modules in a single API call.

cvidstring (int64)

Specify the Custom View ID whose matching records must be mass updated. Use `cvid` to schedule an asynchronous background job that processes the records in the Custom View. Use the [Get Custom View API](custom_views.yaml#$.paths./settings/custom_views.get) to get the ID of the requires custom view. The response returns a `job_id` that can be passed to [Get Mass Update Status API](mass_update.yaml#$.paths./{module}/actions/mass_update.get) to track the progress of the scheduled job. > **Note**: > The cvid key is supported for mass update via API in the following editions: > - Enterprise > - Ultimate > - CRM Plus > - Zoho One Enterprise

territoryobject

Specify the territory whose records must be mass updated. This key is valid only when you provide a Custom View ID in `cvid`.

idstring (int64)required

Specify the unique ID of the territory. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to get the ID of the required territory.

include_childboolean

Specify whether to include the records of the child territories in the mass update. Possible values: **true** - Include the records of the child territories. **false** - Restrict the mass update to the records in the specified territory only.

json

{
  "data": [
    {}
  ],
  "ids": [
    "string"
  ],
  "cvid": "string",
  "territory": {
    "id": "string",
    "include_child": false
  }
}

Response

Returns 200 with an object. Read it in later steps with {{massUpdateRecords.response.data.<field>}}.

dataarray<object>

Represents the array that contains one response object per record processed or one entry describing the scheduled job.

codestringrequired

Represents the result code for the individual entry.

One ofSUCCESS

detailsobjectrequired

Represents additional details about the response.

messagestring (string)required

Represents the message describing the result of the operation.

statusstringrequired

Represents the status of the operation for this entry.

One ofsuccess

json

{
  "data": [
    {
      "code": "SUCCESS",
      "details": {},
      "message": "string",
      "status": "success"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?