Create Subscriber Import

POST

api

subscribers

imports

curl --request POST \
  --url https://api.sequenzy.com/api/v1/subscribers/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscribers": [
    {}
  ],
  "duplicateStrategy": "<string>",
  "listIds": [
    "<string>"
  ],
  "optInMode": "<string>",
  "enrollInSequences": true,
  "defaultPhoneCountry": "<string>",
  "smsConsent": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/subscribers/imports"

payload = {
    "subscribers": [{}],
    "duplicateStrategy": "<string>",
    "listIds": ["<string>"],
    "optInMode": "<string>",
    "enrollInSequences": True,
    "defaultPhoneCountry": "<string>",
    "smsConsent": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscribers: [{}],
    duplicateStrategy: '<string>',
    listIds: ['<string>'],
    optInMode: '<string>',
    enrollInSequences: true,
    defaultPhoneCountry: '<string>',
    smsConsent: true
  })
};

fetch('https://api.sequenzy.com/api/v1/subscribers/imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/subscribers/imports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscribers' => [
        [
                
        ]
    ],
    'duplicateStrategy' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'optInMode' => '<string>',
    'enrollInSequences' => true,
    'defaultPhoneCountry' => '<string>',
    'smsConsent' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/subscribers/imports"

	payload := strings.NewReader("{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/subscribers/imports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/subscribers/imports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "import": {
    "id": "import_abc123",
    "batchId": "batch_abc123",
    "status": "running",
    "totalRows": 1,
    "emailCount": 1,
    "duplicateRows": 0
  },
  "message": "Queued 1 subscriber for import."
}

Use this endpoint for CRM migrations and first-list onboarding instead of issuing one create request per contact. The request returns 202 immediately; use the returned import ID with Get Subscriber Import.

Permissions

The API key needs subscribers:write. Supplying listIds also requires lists:write; requesting sequence enrollment or double-opt-in delivery requires automations:trigger.

subscribers

object[]

required

One to 5,000 records. Every record requires email and may include externalId, firstName, lastName, phone, status, tags, and typed customAttributes.

duplicateStrategy

string

default:"skip"

skip, merge, or overwrite.

listIds

string[]

List IDs to apply to every imported subscriber. Every ID must belong to the authenticated workspace.

optInMode

string

default:"default"

default obeys the workspace setting, confirmed imports contacts whose consent has already been verified, and double_opt_in queues confirmation delivery. Keys without automations:trigger must use confirmed for active consented contacts.

enrollInSequences

boolean

default:"false"

Enroll matching subscribers after import. Requires automations:trigger.

defaultPhoneCountry

string

Two-letter country code used to normalize national-format phone numbers.

Apply the supplied SMS consent to imported phone numbers. Never infer this from phone presence.

curl -X POST "https://api.sequenzy.com/api/v1/subscribers/imports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "copper-export.csv",
    "duplicateStrategy": "merge",
    "optInMode": "confirmed",
    "listIds": ["list_abc123"],
    "subscribers": [{
      "email": "coach@example.com",
      "externalId": "copper-23",
      "firstName": "Ari",
      "lastName": "Tan",
      "phone": "81234567",
      "tags": ["copper", "consented"],
      "customAttributes": { "source": "Copper", "sessions": 4 }
    }]
  }'

{
  "success": true,
  "import": {
    "id": "import_abc123",
    "batchId": "batch_abc123",
    "status": "running",
    "totalRows": 1,
    "emailCount": 1,
    "duplicateRows": 0
  },
  "message": "Queued 1 subscriber for import."
}

A completed import can contain row failures. Always inspect failedCount and failedReasons before treating the migration as successful.

Get Subscriber ImportGet progress and row outcomes for a queued subscriber import

Create Subscriber Import

curl --request POST \
  --url https://api.sequenzy.com/api/v1/subscribers/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscribers": [
    {}
  ],
  "duplicateStrategy": "<string>",
  "listIds": [
    "<string>"
  ],
  "optInMode": "<string>",
  "enrollInSequences": true,
  "defaultPhoneCountry": "<string>",
  "smsConsent": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/subscribers/imports"

payload = {
    "subscribers": [{}],
    "duplicateStrategy": "<string>",
    "listIds": ["<string>"],
    "optInMode": "<string>",
    "enrollInSequences": True,
    "defaultPhoneCountry": "<string>",
    "smsConsent": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscribers: [{}],
    duplicateStrategy: '<string>',
    listIds: ['<string>'],
    optInMode: '<string>',
    enrollInSequences: true,
    defaultPhoneCountry: '<string>',
    smsConsent: true
  })
};

fetch('https://api.sequenzy.com/api/v1/subscribers/imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/subscribers/imports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscribers' => [
        [
                
        ]
    ],
    'duplicateStrategy' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'optInMode' => '<string>',
    'enrollInSequences' => true,
    'defaultPhoneCountry' => '<string>',
    'smsConsent' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/subscribers/imports"

	payload := strings.NewReader("{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/subscribers/imports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/subscribers/imports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscribers\": [\n    {}\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"enrollInSequences\": true,\n  \"defaultPhoneCountry\": \"<string>\",\n  \"smsConsent\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "import": {
    "id": "import_abc123",
    "batchId": "batch_abc123",
    "status": "running",
    "totalRows": 1,
    "emailCount": 1,
    "duplicateRows": 0
  },
  "message": "Queued 1 subscriber for import."
}

Overview

Companies

Sync Rules

Shopify

Websites

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Create Subscriber Import

Permissions

​Permissions

Permissions