CLclose
bulk_actions.edit

Initiate a new bulk edit

Changed on

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.

post/bulk_action/edit/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/bulk_action/edit/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Response

Successful response

created_bystring nullable required
custom_field_namestring nullable required
custom_field_valuestring nullable required
date_createdstring date-time nullable required
date_updatedstring date-time nullable required
idstring required
lead_status_idstring nullable required
n_leadsinteger nullable required
n_leads_processedinteger required
n_objectsinteger nullable required
n_objects_processedinteger required
organization_idstring required
querystring nullable required
results_limitinteger nullable required
s_queryobject required
send_done_emailboolean required
sortobject[] 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_bystring nullable required

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status