Initiate a new bulk edit | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/bulk_action/edit/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "lead_status_id": "stat_t7Zd2uspYPvBafR5bu9agrFZFs8GToWIbDnkqSk8nT8",
  "s_query": {
    "queries": [
      {
        "object_type": "lead",
        "type": "object_type"
      },
      {
        "condition": {
          "mode": "full_words",
          "type": "text",
          "value": "ACME Inc."
        },
        "field": {
          "field_name": "name",
          "object_type": "lead",
          "type": "regular_field"
        },
        "type": "field_condition"
      }
    ],
    "type": "and"
  },
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "type": "set_lead_status"
}'

{
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2015-03-16T00:19:50.141000+00:00",
  "date_updated": "2015-03-16T00:20:09.442000+00:00",
  "id": "bulkedit_asdVYCm54A0El829k39e7nIvlCSDDhVLuyb8aspGSET",
  "lead_status_id": "stat_t7Zd2uspYPvBafR5bu9agrFZFs8GToWIbDnkqSk8nT8",
  "n_leads_processed": 0,
  "n_objects_processed": 0,
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "query": "lead_status:Potential",
  "s_query": {
    "queries": [
      {
        "object_type": "lead",
        "type": "object_type"
      },
      {
        "condition": {
          "mode": "full_words",
          "type": "text",
          "value": "ACME Inc."
        },
        "field": {
          "field_name": "name",
          "object_type": "lead",
          "type": "regular_field"
        },
        "type": "field_condition"
      }
    ],
    "type": "and"
  },
  "send_done_email": true,
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "status": "created",
  "type": "set_lead_status",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

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.

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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects any.

Response

Successful response

created_bystring or null

custom_field_namestring or null

custom_field_valuestring or null

date_createddatetime or null

date_updateddatetime or null

idstring

lead_status_idstring or null

n_leadsinteger or null

n_leads_processedinteger

n_objectsinteger or null

n_objects_processedinteger

organization_idstring

querystring or null

results_limitinteger or null

s_querymap from strings to any

send_done_emailboolean

sortlist of maps from strings to any

statusenum or null

typeenum

updated_bystring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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.