Create Warehouse Sync

POST

api

warehouse-syncs

curl --request POST \
  --url https://api.sequenzy.com/api/v1/warehouse-syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionId": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "query": "<string>",
  "mapping": {},
  "cursorColumn": {},
  "frequency": "<string>",
  "listIds": [
    "<string>"
  ],
  "optInMode": "<string>",
  "triggerAutomations": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/warehouse-syncs"

payload = {
    "connectionId": "<string>",
    "name": "<string>",
    "kind": "<string>",
    "query": "<string>",
    "mapping": {},
    "cursorColumn": {},
    "frequency": "<string>",
    "listIds": ["<string>"],
    "optInMode": "<string>",
    "triggerAutomations": 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({
    connectionId: '<string>',
    name: '<string>',
    kind: '<string>',
    query: '<string>',
    mapping: {},
    cursorColumn: {},
    frequency: '<string>',
    listIds: ['<string>'],
    optInMode: '<string>',
    triggerAutomations: true
  })
};

fetch('https://api.sequenzy.com/api/v1/warehouse-syncs', 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/warehouse-syncs",
  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([
    'connectionId' => '<string>',
    'name' => '<string>',
    'kind' => '<string>',
    'query' => '<string>',
    'mapping' => [
        
    ],
    'cursorColumn' => [
        
    ],
    'frequency' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'optInMode' => '<string>',
    'triggerAutomations' => 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/warehouse-syncs"

	payload := strings.NewReader("{\n  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": 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/warehouse-syncs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/warehouse-syncs")

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  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": true\n}"

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

{
  "success": true,
  "sync": {
    "id": "wsync_abc123",
    "connectionId": "wconn_abc123",
    "name": "Customers",
    "kind": "subscribers",
    "query": "select email, first_name, plan, updated_at from analytics.customers",
    "mapping": {
      "emailColumn": "EMAIL",
      "firstNameColumn": "FIRST_NAME",
      "attributes": [
        {
          "column": "PLAN",
          "attribute": "plan"
        }
      ]
    },
    "cursorColumn": "UPDATED_AT",
    "cursorValue": null,
    "listIds": [],
    "optInMode": "confirmed",
    "triggerAutomations": false,
    "frequency": "hourly",
    "isEnabled": true,
    "fullResyncRequested": false,
    "status": "queued",
    "nextRunAt": "2026-09-30T13:00:00.000Z",
    "lastRunAt": "2026-09-30T12:00:00.000Z",
    "lastSuccessAt": "2026-09-30T12:00:41.000Z",
    "lastError": null,
    "lastErrorAt": null,
    "consecutiveFailures": 0,
    "latestRun": null,
    "createdAt": "2026-09-30T10:00:00.000Z",
    "updatedAt": "2026-09-30T12:00:41.000Z"
  }
}

{
  "success": false,
  "code": "invalid_mapping",
  "error": "emailColumn \"MAIL\" is not a column of the query. Available columns: EMAIL, FIRST_NAME, PLAN, UPDATED_AT."
}

{
  "success": false,
  "code": "missing_scope",
  "error": "Starting automations or sending double opt-in emails from a sync requires the automations:trigger permission."
}

Creates a sync. Each run executes the query and sends only rows that changed since they were last sent:

subscribers syncs create and update contacts through the same pipeline as imports, with duplicate strategy overwrite: mapped values replace stored ones, empty values never clear data, tags are only added, and unsubscribed contacts are never resubscribed.
events syncs record events on contacts that already exist. Events older than an hour are stored as history and never start automations.

The mapping and cursor column are checked against the query’s real columns, and the first run starts right away. Requires warehouse:write and subscribers:write. Event syncs also need events:write. triggerAutomations: true or optInMode: "double_opt_in" need automations:trigger.

Request

string

required

string

required

string

required

subscribers or events.

string

required

A single SELECT or WITH statement.

object

required

Column names as the query returns them (Snowflake returns unquoted names in upper case).subscribers: emailColumn (or phoneColumn for SMS-only contacts), externalIdColumn, firstNameColumn, lastNameColumn, tagsColumn (array or comma-separated string) and attributes, a list of { "column", "attribute" } pairs.events: emailColumn or externalIdColumn to find the contact, eventNameColumn or a fixed eventName, eventIdColumn (stable ID; derived from the row when omitted), occurredAtColumn (defaults to the sync time) and properties, a list of { "column", "property" } pairs.

string | null

A column that grows when a row changes, such as updated_at. Each run reads only rows at or after the last value it saw. Without a cursor, every run reads the whole result (up to 2,000,000 rows) and skips unchanged rows.

string

default:"daily"

every_15_minutes, hourly, daily, weekly or manual.

string[]

Subscriber syncs: lists that contacts the sync creates join. Existing contacts keep their list memberships.

string

default:"confirmed"

Subscriber syncs: confirmed for contacts whose consent is already verified, or double_opt_in to email new contacts a confirmation first.

boolean

default:"false"

Let new contacts, or events from the last hour, start automations.

curl -X POST "https://api.sequenzy.com/api/v1/warehouse-syncs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionId": "wconn_abc123",
    "name": "Customers",
    "kind": "subscribers",
    "query": "select email, first_name, plan, updated_at from analytics.customers",
    "mapping": {
      "emailColumn": "EMAIL",
      "firstNameColumn": "FIRST_NAME",
      "attributes": [{ "column": "PLAN", "attribute": "plan" }]
    },
    "cursorColumn": "UPDATED_AT",
    "frequency": "hourly"
  }'

{
  "success": true,
  "sync": {
    "id": "wsync_abc123",
    "connectionId": "wconn_abc123",
    "name": "Customers",
    "kind": "subscribers",
    "query": "select email, first_name, plan, updated_at from analytics.customers",
    "mapping": {
      "emailColumn": "EMAIL",
      "firstNameColumn": "FIRST_NAME",
      "attributes": [
        {
          "column": "PLAN",
          "attribute": "plan"
        }
      ]
    },
    "cursorColumn": "UPDATED_AT",
    "cursorValue": null,
    "listIds": [],
    "optInMode": "confirmed",
    "triggerAutomations": false,
    "frequency": "hourly",
    "isEnabled": true,
    "fullResyncRequested": false,
    "status": "queued",
    "nextRunAt": "2026-09-30T13:00:00.000Z",
    "lastRunAt": "2026-09-30T12:00:00.000Z",
    "lastSuccessAt": "2026-09-30T12:00:41.000Z",
    "lastError": null,
    "lastErrorAt": null,
    "consecutiveFailures": 0,
    "latestRun": null,
    "createdAt": "2026-09-30T10:00:00.000Z",
    "updatedAt": "2026-09-30T12:00:41.000Z"
  }
}

{
  "success": false,
  "code": "invalid_mapping",
  "error": "emailColumn \"MAIL\" is not a column of the query. Available columns: EMAIL, FIRST_NAME, PLAN, UPDATED_AT."
}

{
  "success": false,
  "code": "missing_scope",
  "error": "Starting automations or sending double opt-in emails from a sync requires the automations:trigger permission."
}

Create Warehouse Sync

curl --request POST \
  --url https://api.sequenzy.com/api/v1/warehouse-syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionId": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "query": "<string>",
  "mapping": {},
  "cursorColumn": {},
  "frequency": "<string>",
  "listIds": [
    "<string>"
  ],
  "optInMode": "<string>",
  "triggerAutomations": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/warehouse-syncs"

payload = {
    "connectionId": "<string>",
    "name": "<string>",
    "kind": "<string>",
    "query": "<string>",
    "mapping": {},
    "cursorColumn": {},
    "frequency": "<string>",
    "listIds": ["<string>"],
    "optInMode": "<string>",
    "triggerAutomations": 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({
    connectionId: '<string>',
    name: '<string>',
    kind: '<string>',
    query: '<string>',
    mapping: {},
    cursorColumn: {},
    frequency: '<string>',
    listIds: ['<string>'],
    optInMode: '<string>',
    triggerAutomations: true
  })
};

fetch('https://api.sequenzy.com/api/v1/warehouse-syncs', 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/warehouse-syncs",
  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([
    'connectionId' => '<string>',
    'name' => '<string>',
    'kind' => '<string>',
    'query' => '<string>',
    'mapping' => [
        
    ],
    'cursorColumn' => [
        
    ],
    'frequency' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'optInMode' => '<string>',
    'triggerAutomations' => 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/warehouse-syncs"

	payload := strings.NewReader("{\n  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": 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/warehouse-syncs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/warehouse-syncs")

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  \"connectionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"query\": \"<string>\",\n  \"mapping\": {},\n  \"cursorColumn\": {},\n  \"frequency\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"optInMode\": \"<string>\",\n  \"triggerAutomations\": true\n}"

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

{
  "success": true,
  "sync": {
    "id": "wsync_abc123",
    "connectionId": "wconn_abc123",
    "name": "Customers",
    "kind": "subscribers",
    "query": "select email, first_name, plan, updated_at from analytics.customers",
    "mapping": {
      "emailColumn": "EMAIL",
      "firstNameColumn": "FIRST_NAME",
      "attributes": [
        {
          "column": "PLAN",
          "attribute": "plan"
        }
      ]
    },
    "cursorColumn": "UPDATED_AT",
    "cursorValue": null,
    "listIds": [],
    "optInMode": "confirmed",
    "triggerAutomations": false,
    "frequency": "hourly",
    "isEnabled": true,
    "fullResyncRequested": false,
    "status": "queued",
    "nextRunAt": "2026-09-30T13:00:00.000Z",
    "lastRunAt": "2026-09-30T12:00:00.000Z",
    "lastSuccessAt": "2026-09-30T12:00:41.000Z",
    "lastError": null,
    "lastErrorAt": null,
    "consecutiveFailures": 0,
    "latestRun": null,
    "createdAt": "2026-09-30T10:00:00.000Z",
    "updatedAt": "2026-09-30T12:00:41.000Z"
  }
}

{
  "success": false,
  "code": "invalid_mapping",
  "error": "emailColumn \"MAIL\" is not a column of the query. Available columns: EMAIL, FIRST_NAME, PLAN, UPDATED_AT."
}

{
  "success": false,
  "code": "missing_scope",
  "error": "Starting automations or sending double opt-in emails from a sync requires the automations:trigger permission."
}

​Request

Request