Initiate a new bulk sequence subscription

POST

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

POST

/api/v1/bulk_action/sequence_subscription/

curl -X POST https://api.close.com/api/v1/bulk_action/sequence_subscription/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "action_type": "subscribe",
  "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"
  },
  "sender_account_id": "emailacct_aslkdjfalksjdfCmLShmuvlPMFy7Ze61FVeEj1VXnlG",
  "sender_email": "john@salesteam.com",
  "sender_name": "John Doe",
  "sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ]
}'

{
  "action_type": "subscribe",
  "caller_id_mode": null,
  "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": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "status": "processing",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

action_type must be one of:

subscribe to create a new sequence subscription for contacts that have never received the given sequence.
resume to resume any paused sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.
resume_finished to resume any finished sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.
pause to pause any active sequence subscriptions for the given sequence or all sequences if sequence_id is not provided.

sequence_id, sender_account_id, sender_name, sender_email and contact_preference are required if action_type is subscribe.

contact_preference can be set to:

lead to only subscribe the primary/first contact email of the lead.
contact to subscribe the primary email of each contact of the lead.

subscribe, resume and resume_finished all start or restart Workflow runs, so they require a plan that includes them and otherwise return a 400. pause and reassign remain available on every plan.

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

action_typeenum

Allowed values:

caller_id_modeenum or null

How a caller's outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).

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