List bulk emails | Close | Developer API Documentation

curl https://api.close.com/api/v1/bulk_action/email/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "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": 824,
      "n_leads_processed": 523,
      "n_objects": 824,
      "n_objects_processed": 523,
      "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": [],
      "status": "processing",
      "template_id": "tmpl_00jcushDRuoBBS5sSTUAbNt4dPpBUhlJqQafVfzzRJn",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "has_more": false
}

curl https://api.close.com/api/v1/bulk_action/email/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "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": 824,
      "n_leads_processed": 523,
      "n_objects": 824,
      "n_objects_processed": 523,
      "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": [],
      "status": "processing",
      "template_id": "tmpl_00jcushDRuoBBS5sSTUAbNt4dPpBUhlJqQafVfzzRJn",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "has_more": false
}

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.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

_fieldsstringOptional

Comma-separated list of fields to include in the response.

template_idstring or nullOptional

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/bulk_action/email/ \
>	-u "<CLOSE_API_KEY>:"

1	{
2	"data": [
3	{
4	"contact_preference": "lead",
5	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6	"date_created": "2013-12-05T18:34:41.753000+00:00",
7	"date_updated": "2013-12-05T19:33:29.357000+00:00",
8	"email_account_id": "emailacct_qwSIFLEjbJXBJOGb0KsqSvnxX5P9DTXUMnb6mFBLxNt",
9	"id": "bulkemail_qmjJY85TSmMBqw1MKgL5o3LdSJkvklqfAwfdcjiRYCy",
10	"n_leads": 824,
11	"n_leads_processed": 523,
12	"n_objects": 824,
13	"n_objects_processed": 523,
14	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
15	"query": "lead_status:Potential",
16	"results_limit": null,
17	"s_query": {
18	"queries": [
19	{
20	"object_type": "lead",
21	"type": "object_type"
22	},
23	{
24	"condition": {
25	"mode": "full_words",
26	"type": "text",
27	"value": "ACME Inc."
28	},
29	"field": {
30	"field_name": "name",
31	"object_type": "lead",
32	"type": "regular_field"
33	},
34	"type": "field_condition"
35	}
36	],
37	"type": "and"
38	},
39	"send_done_email": false,
40	"sender": "sender@example.com",
41	"sort": [],
42	"status": "processing",
43	"template_id": "tmpl_00jcushDRuoBBS5sSTUAbNt4dPpBUhlJqQafVfzzRJn",
44	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
45	}
46	],
47	"has_more": false
48	}