---
title: "Initiate a new bulk edit"
method: POST
path: "/bulk_action/edit/"
tags: ["bulk_actions.edit"]
---

# Initiate a new bulk edit

`POST /bulk_action/edit/`

Pass additional parameters depending on which `type` is passed:

 - `set_lead_status` will set the Lead Status on all leads. It expects:
  - `lead_status_id` - ID of the Lead Status to use.
 - `clear_custom_field` will clear/remove/unset a specific custom field from all leads. It expects:
  - `custom_field_id` or `custom_field_name` - ID or exact name of the custom field to remove.
 - `set_custom_field` will set/update/add a specific custom field on all leads. It expects:
  - `custom_field_id` or `custom_field_name` - ID or exact name of the custom field to set/update.
  - `custom_field_value` - New value. Use `custom_field_values` to pass multiple values to custom fields that support it.
  - `custom_field_operation` - `replace`, `add`, or `remove` (defaults to `replace`). Only applicable for custom fields that accept multiple values.

Use `"send_done_email": false` if you don't want to get a confirmation email after the bulk action is done.

## Response `200`

Successful response

- BulkEditAction
  - `created_by` string, nullable, required
  - `custom_field_name` string, nullable, required
  - `custom_field_value` string, nullable, required
  - `date_created` string, date-time, nullable, required
  - `date_updated` string, date-time, nullable, required
  - `id` string, required
  - `lead_status_id` string, nullable, required
  - `n_leads` integer, nullable, required
  - `n_leads_processed` integer, required
  - `n_objects` integer, nullable, required
  - `n_objects_processed` integer, required
  - `organization_id` string, required
  - `query` string, nullable, required
  - `results_limit` integer, nullable, required
  - `s_query` object, required
  - `send_done_email` boolean, required
  - `sort` object[], required
  - `status` 'created' | 'loading' | 'processing' | 'done' | 'paused' | 'resuming' | 'error', required
  - `type` 'set_custom_field' | 'clear_custom_field' | 'set_lead_status' | 'set_contact_custom_field' | 'clear_contact_custom_field' | 'set_activity_custom_field' | 'clear_activity_custom_field' | 'set_global_custom_field' | 'clear_global_custom_field' | 'set_opportunity_custom_field' | 'clear_opportunity_custom_field' | 'set_custom_object_custom_field' | 'clear_custom_object_custom_field', required
  - `updated_by` string, nullable, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.net/close/apis/close-api.md) · [All operations](https://skmtc.net/close/apis/close-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/close/close-api/revisions/0dcf3303e9d7/schema)