Fetch a single bulk sequence subscription object

GET

https://api.close.com/api/v1/bulk_action/sequence_subscription/:id/

GET

/api/v1/bulk_action/sequence_subscription/:id/

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

1 {
2   "action_type": "subscribe",
3   "calls_assigned_to": null,
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   "from_phone_number_id": null,
9   "id": "bulkseqsub_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_account_id": "emailacct_aslkdjfalksjdfCmLShmuvlPMFy7Ze61FVeEj1VXnlG",
41   "sender_email": "john@salesteam.com",
42   "sender_name": "John Doe",
43   "sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
44   "sort": [],
45   "status": "processing",
46   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
47 }

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

{
  "action_type": "subscribe",
  "calls_assigned_to": null,
  "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",
  "from_phone_number_id": null,
  "id": "bulkseqsub_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_account_id": "emailacct_aslkdjfalksjdfCmLShmuvlPMFy7Ze61FVeEj1VXnlG",
  "sender_email": "john@salesteam.com",
  "sender_name": "John Doe",
  "sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
  "sort": [],
  "status": "processing",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

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.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

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

Response

Successful response

action_typeenum

Allowed values:

calls_assigned_tolist of strings or null

contact_preferenceenum or null

Allowed values:

created_bystring or null

date_createddatetime or null

date_updateddatetime or null

from_phone_number_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

sender_account_idstring or null

sender_emailstring or null

sender_namestring or null

sequence_idstring or null

sortlist of maps from strings to any

statusenum or null

updated_bystring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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

1	{
2	"action_type": "subscribe",
3	"calls_assigned_to": null,
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	"from_phone_number_id": null,
9	"id": "bulkseqsub_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_account_id": "emailacct_aslkdjfalksjdfCmLShmuvlPMFy7Ze61FVeEj1VXnlG",
41	"sender_email": "john@salesteam.com",
42	"sender_name": "John Doe",
43	"sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
44	"sort": [],
45	"status": "processing",
46	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
47	}