Initiate a new bulk email | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/bulk_action/email/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "contact_preference": "lead",
  "results_limit": null,
  "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": false,
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "template_id": "tmpl_00jcushDRuoBBS5sSTUAbNt4dPpBUhlJqQafVfzzRJn"
}'

{
  "contact_preference": "lead",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-12-05T18:34:41.753000+00:00",
  "date_updated": "2013-12-05T19:33:29.357000+00:00",
  "email_account_id": "emailacct_qwSIFLEjbJXBJOGb0KsqSvnxX5P9DTXUMnb6mFBLxNt",
  "id": "bulkemail_qmjJY85TSmMBqw1MKgL5o3LdSJkvklqfAwfdcjiRYCy",
  "n_leads": null,
  "n_leads_processed": 0,
  "n_objects": null,
  "n_objects_processed": 0,
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "query": "lead_status:Potential",
  "results_limit": null,
  "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": false,
  "sender": "sender@example.com",
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "status": "created",
  "template_id": "tmpl_00jcushDRuoBBS5sSTUAbNt4dPpBUhlJqQafVfzzRJn",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

contact_preference can be set to lead (only email the primary/first contact email of the lead) or contact (email the first contact email of each contact of the lead).

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

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

Request

This endpoint expects any.

Response

Successful response

contact_preferenceenum or null

Allowed values:

created_bystring or null

date_createddatetime or null

date_updateddatetime or null

email_account_idstring or null

idstring

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

senderstring or null

sortlist of maps from strings to any

statusenum or null

template_idstring or null

updated_bystring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error