Turn on, change or pause a sync

Sends the people in a saved view automatically from now on: a sync. It sends to Slack, Google Sheets, Clay, a webhook, email or an outreach tool. It turns on, changes, pauses, resumes or stops the sync from one People view to one destination. A destination is a Slack channel, an email list, a webhook or a connected app. A sync sends people automatically. mode once sends each person when they enter the view. every_time sends each new like, comment, share or profile view by someone in the view instead. every_time does not send the people who enter. Starting a sync sends nothing for the people already in the view. add_email and add_phone look up contact details, for Leads only. add_email costs 5 credits per verified email found, add_phone 25 credits per number found. On a workspace that pays in credits, switching either on, or lookup_current_members, asks first. The first call then returns a summary with the cost and a confirm_id. Ziplined saves the sync when you call again with the same arguments plus confirm_id. all_leads: true instead of a view syncs every lead from every source (Slack, email or webhook). For a HeyReach, Instantly or Waalaxy campaign or list, pass the account id as destination. The account id is in accounts in list_destinations. Pass the campaign or list id from list_destination_targets as target. For a HeyReach lead list, add target_kind: list. new_list_name instead of target makes a new HeyReach list. A person in a HeyReach list gets no message until the user adds the list to a campaign in HeyReach. An outreach sync sends each person once and looks up no contact details. An outreach sync to Instantly needs the contacts scope. paused: true holds a sync and keeps its choices. paused: false resumes it, and sends only the people who enter from then on. enabled: false stops it. Tell the user what the answer says will happen. Use when: The user wants people sent somewhere automatically from now on. Example: "every time someone new lands in my list, push them to Slack". Also to pause, resume or stop a sync. view and destination take names, as the user says them, so the view needs no lookup first. An unknown name comes back as not_found with similar names. For an outreach campaign, find its id with list_destination_targets. Do not use for: A one-off send right now (use send_people instead). A destination that the user did not connect yet (use connect_destination or save_destination instead). Example: {"view":"Warm leads","destination":"#leads","enabled":true,"mode":"once"}

PUT

views

{id}

syncs

{destination_id}

Turn on, change or pause a sync

curl --request PUT \
  --url https://api.ziplined.io/v1/views/{id}/syncs/{destination_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "all_leads": true,
  "target": "<string>",
  "new_list_name": "<string>",
  "paused": true,
  "send_hour_utc": 11,
  "add_email": true,
  "add_phone": true,
  "lookup_current_members": true,
  "send_everyone": true,
  "send_contacts": true,
  "resend_not_sent": true,
  "confirm_id": "<string>"
}
'

import requests

url = "https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}"

payload = {
    "enabled": True,
    "all_leads": True,
    "target": "<string>",
    "new_list_name": "<string>",
    "paused": True,
    "send_hour_utc": 11,
    "add_email": True,
    "add_phone": True,
    "lookup_current_members": True,
    "send_everyone": True,
    "send_contacts": True,
    "resend_not_sent": True,
    "confirm_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    all_leads: true,
    target: '<string>',
    new_list_name: '<string>',
    paused: true,
    send_hour_utc: 11,
    add_email: true,
    add_phone: true,
    lookup_current_members: true,
    send_everyone: true,
    send_contacts: true,
    resend_not_sent: true,
    confirm_id: '<string>'
  })
};

fetch('https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}', 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.ziplined.io/v1/views/{id}/syncs/{destination_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'all_leads' => true,
    'target' => '<string>',
    'new_list_name' => '<string>',
    'paused' => true,
    'send_hour_utc' => 11,
    'add_email' => true,
    'add_phone' => true,
    'lookup_current_members' => true,
    'send_everyone' => true,
    'send_contacts' => true,
    'resend_not_sent' => true,
    'confirm_id' => '<string>'
  ]),
  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.ziplined.io/v1/views/{id}/syncs/{destination_id}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}"

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

{
  "sync": {
    "id": "<string>",
    "view_id": "<string>",
    "destination": {
      "id": "<string>",
      "provider": "<string>",
      "name": "<string>",
      "status": "connected"
    },
    "status": "active",
    "mode": "once",
    "frequency": "hourly",
    "send_hour_utc": 123,
    "add_email": true,
    "add_phone": true,
    "not_sent": 123
  },
  "effects": [
    "<string>"
  ],
  "lookup": {
    "run_id": "<string>",
    "status": "<string>",
    "started": true
  },
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key

string

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255

Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Path Parameters

string

The People view that sends, by name or id from list_views.

Required string length: 1 - 200

destination_id

string

required

Where it sends, by name or id from list_destinations. With target: the id of the outreach account, from accounts in list_destinations.

Required string length: 1 - 200

Body

application/json

enabled

boolean

required

true turns the sync on, or keeps it on. false stops it and drops its choices. Turning it on again starts over. There is no delete. To hold a sync and keep its choices, use paused.

all_leads

boolean

true: the sync of all leads, every lead from every source, without a view (the Leads table). Instead of view.

target

string

A campaign or list id from list_destination_targets. With target, destination is its account. The sync sends each person who enters the view to that campaign or list once.

Required string length: 1 - 256

target_kind

enum<string>

HeyReach only: list when target is a lead list, campaign when it is a campaign. Left out: campaign (HeyReach, Instantly) or list (Waalaxy). A person in a HeyReach list gets no message until the user adds the list to a campaign in HeyReach.

Available options:

campaign,

list

new_list_name

string

HeyReach only, instead of target: makes a new HeyReach lead list with this name and syncs the view to it. Destination is the HeyReach account. Usually the name of the view.

Required string length: 1 - 100

paused

boolean

true pauses a sync that exists: it sends nothing until you resume it. Its mode, frequency and contact details stay. false resumes it from a new baseline. Goes with enabled: true and nothing else. You cannot pause the sync of all leads; stop it with enabled: false.

mode

enum<string>

once: each person is sent once, when they enter the view. every_time: each new like, comment, share or profile view by a person in the view is sent. Left out: unchanged, or once for a new sync.

Available options:

once,

every_time

frequency

enum<string>

How the sync bundles its sends: hourly, daily, or weekly on Monday. Left out: unchanged, or the default of the destination for a new sync.

Available options:

hourly,

daily,

weekly

send_hour_utc

integer

With frequency daily or weekly: the whole hour in UTC. Default 7.

Required range: 0 <= x <= 23

add_email

boolean

Look up the work email of each Lead sent. 5 credits per verified email found.

add_phone

boolean

Look up the phone number of each Lead sent. 25 credits per number found.

lookup_current_members

boolean

Also look up email or phone (the ticked ones) for the Leads already in the view, once. It sends nothing for them. A view without a Lead fails with not_a_lead.

send_everyone

boolean

true: also send everyone in the view now, once (at most 10000). Only for a New people sync to Google Sheets, Clay, a webhook or an outreach app. They start going out within a minute and count as sent, so the sync sends only new people after that. The destination gets a new row for people it already has. You cannot undo a send, so it asks first, except for an outreach list, which sends no messages.

send_contacts

boolean

With send_everyone, on a webhook sync with add_email or add_phone: false sends everyone without contact details, for no credits. Left out: Ziplined looks up their contact details, and you pay only for what it finds.

resend_not_sent

boolean

true: queue again the people this sync did not reach (sync.not_sent). Their deliveries ran out of attempts since its last send. The sync sends each of them once, with what it would have sent then.

confirm_id

string

The confirm_id of a needs_confirmation answer: commits what that answer summarised.

Response

The result, or without confirm_id first a needs_confirmation answer: nothing happened yet.

Option 1
Option 2

sync

object

required

Show child attributes

effects

string[]

required

What this does, in plain words. Tell the user.

lookup

object | null

required

Show child attributes

app_url

string

required

Turn on, change or pause a sync

curl --request PUT \
  --url https://api.ziplined.io/v1/views/{id}/syncs/{destination_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "all_leads": true,
  "target": "<string>",
  "new_list_name": "<string>",
  "paused": true,
  "send_hour_utc": 11,
  "add_email": true,
  "add_phone": true,
  "lookup_current_members": true,
  "send_everyone": true,
  "send_contacts": true,
  "resend_not_sent": true,
  "confirm_id": "<string>"
}
'

import requests

url = "https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}"

payload = {
    "enabled": True,
    "all_leads": True,
    "target": "<string>",
    "new_list_name": "<string>",
    "paused": True,
    "send_hour_utc": 11,
    "add_email": True,
    "add_phone": True,
    "lookup_current_members": True,
    "send_everyone": True,
    "send_contacts": True,
    "resend_not_sent": True,
    "confirm_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    all_leads: true,
    target: '<string>',
    new_list_name: '<string>',
    paused: true,
    send_hour_utc: 11,
    add_email: true,
    add_phone: true,
    lookup_current_members: true,
    send_everyone: true,
    send_contacts: true,
    resend_not_sent: true,
    confirm_id: '<string>'
  })
};

fetch('https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}', 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.ziplined.io/v1/views/{id}/syncs/{destination_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'all_leads' => true,
    'target' => '<string>',
    'new_list_name' => '<string>',
    'paused' => true,
    'send_hour_utc' => 11,
    'add_email' => true,
    'add_phone' => true,
    'lookup_current_members' => true,
    'send_everyone' => true,
    'send_contacts' => true,
    'resend_not_sent' => true,
    'confirm_id' => '<string>'
  ]),
  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.ziplined.io/v1/views/{id}/syncs/{destination_id}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/views/{id}/syncs/{destination_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"all_leads\": true,\n  \"target\": \"<string>\",\n  \"new_list_name\": \"<string>\",\n  \"paused\": true,\n  \"send_hour_utc\": 11,\n  \"add_email\": true,\n  \"add_phone\": true,\n  \"lookup_current_members\": true,\n  \"send_everyone\": true,\n  \"send_contacts\": true,\n  \"resend_not_sent\": true,\n  \"confirm_id\": \"<string>\"\n}"

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

{
  "sync": {
    "id": "<string>",
    "view_id": "<string>",
    "destination": {
      "id": "<string>",
      "provider": "<string>",
      "name": "<string>",
      "status": "connected"
    },
    "status": "active",
    "mode": "once",
    "frequency": "hourly",
    "send_hour_utc": 123,
    "add_email": true,
    "add_phone": true,
    "not_sent": 123
  },
  "effects": [
    "<string>"
  ],
  "lookup": {
    "run_id": "<string>",
    "status": "<string>",
    "started": true
  },
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

People

Companies

Posts

Engagements

Insights

Views

Audiences

ICP

Sources

Account

Credits

Integrations

Turn on, change or pause a sync

Authorizations

Headers

Path Parameters

Body

Response