Put a routing rule on a destination
Sending the same name twice updates that rule instead of adding a second one, and leaves its cursor alone. new_qualified_lead requires an audience_id: the fit tier it asks about hangs off an audience. Requires scope write and an Idempotency-Key.
POST
/
v1
/
integrations
/
{id}
/
rules
Put a routing rule on a destination
curl --request POST \
--url https://api.ziplined.io/v1/integrations/{id}/rules \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"name": "newQualifiedLeads",
"event": "new_qualified_lead",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"via_kind": [],
"engagement_type": [
"<string>"
],
"company_id": [
"<string>"
],
"min_warmth": 50,
"min_fit_score": 50,
"first_engagement_only": true,
"pinned_only": true,
"orbit": [],
"kind": [
"<string>"
],
"status": [
"<string>"
]
},
"is_active": true,
"min_interval_minutes": 0,
"send_hour_utc": 11
}
'import requests
url = "https://api.ziplined.io/v1/integrations/{id}/rules"
payload = {
"name": "newQualifiedLeads",
"event": "new_qualified_lead",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"via_kind": [],
"engagement_type": ["<string>"],
"company_id": ["<string>"],
"min_warmth": 50,
"min_fit_score": 50,
"first_engagement_only": True,
"pinned_only": True,
"orbit": [],
"kind": ["<string>"],
"status": ["<string>"]
},
"is_active": True,
"min_interval_minutes": 0,
"send_hour_utc": 11
}
headers = {
"idempotency-key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'idempotency-key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'newQualifiedLeads',
event: 'new_qualified_lead',
audience_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
filter: {
via_kind: [],
engagement_type: ['<string>'],
company_id: ['<string>'],
min_warmth: 50,
min_fit_score: 50,
first_engagement_only: true,
pinned_only: true,
orbit: [],
kind: ['<string>'],
status: ['<string>']
},
is_active: true,
min_interval_minutes: 0,
send_hour_utc: 11
})
};
fetch('https://api.ziplined.io/v1/integrations/{id}/rules', 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/integrations/{id}/rules",
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([
'name' => 'newQualifiedLeads',
'event' => 'new_qualified_lead',
'audience_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'filter' => [
'via_kind' => [
],
'engagement_type' => [
'<string>'
],
'company_id' => [
'<string>'
],
'min_warmth' => 50,
'min_fit_score' => 50,
'first_engagement_only' => true,
'pinned_only' => true,
'orbit' => [
],
'kind' => [
'<string>'
],
'status' => [
'<string>'
]
],
'is_active' => true,
'min_interval_minutes' => 0,
'send_hour_utc' => 11
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>"
],
]);
$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/integrations/{id}/rules"
payload := strings.NewReader("{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.ziplined.io/v1/integrations/{id}/rules")
.header("idempotency-key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ziplined.io/v1/integrations/{id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"integration_id": "<string>",
"name": "<string>",
"event": "new_engagement",
"is_active": true,
"audience_id": "<string>",
"filter": {},
"min_interval_minutes": 123,
"send_hour_utc": 123,
"watermark_at": "<string>",
"created_at": "<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>"
}
}Headers
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 - 255Example:
"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Path Parameters
Body
application/json
The stable key of this rule inside the destination. Sending it twice updates the rule.
Required string length:
1 - 64Example:
"newQualifiedLeads"
Available options:
new_engagement, new_post, new_qualified_lead, run_completed, account_marked, account_mark_revoked Example:
"new_qualified_lead"
Narrow to this audience. Null is everyone. Required for new_qualified_lead.
Optional narrowing. Every key is optional and all of them are ANDed.
Show child attributes
Show child attributes
How long this rule waits between two messages: 0 immediate, 60 hourly, 1440 daily.
Available options:
0 The whole hour in UTC after which a daily send may go out. Only used at 1440.
Required range:
0 <= x <= 23Response
The rule as it now stands.
Show child attributes
Show child attributes
⌘I
Put a routing rule on a destination
curl --request POST \
--url https://api.ziplined.io/v1/integrations/{id}/rules \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"name": "newQualifiedLeads",
"event": "new_qualified_lead",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"via_kind": [],
"engagement_type": [
"<string>"
],
"company_id": [
"<string>"
],
"min_warmth": 50,
"min_fit_score": 50,
"first_engagement_only": true,
"pinned_only": true,
"orbit": [],
"kind": [
"<string>"
],
"status": [
"<string>"
]
},
"is_active": true,
"min_interval_minutes": 0,
"send_hour_utc": 11
}
'import requests
url = "https://api.ziplined.io/v1/integrations/{id}/rules"
payload = {
"name": "newQualifiedLeads",
"event": "new_qualified_lead",
"audience_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"via_kind": [],
"engagement_type": ["<string>"],
"company_id": ["<string>"],
"min_warmth": 50,
"min_fit_score": 50,
"first_engagement_only": True,
"pinned_only": True,
"orbit": [],
"kind": ["<string>"],
"status": ["<string>"]
},
"is_active": True,
"min_interval_minutes": 0,
"send_hour_utc": 11
}
headers = {
"idempotency-key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'idempotency-key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'newQualifiedLeads',
event: 'new_qualified_lead',
audience_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
filter: {
via_kind: [],
engagement_type: ['<string>'],
company_id: ['<string>'],
min_warmth: 50,
min_fit_score: 50,
first_engagement_only: true,
pinned_only: true,
orbit: [],
kind: ['<string>'],
status: ['<string>']
},
is_active: true,
min_interval_minutes: 0,
send_hour_utc: 11
})
};
fetch('https://api.ziplined.io/v1/integrations/{id}/rules', 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/integrations/{id}/rules",
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([
'name' => 'newQualifiedLeads',
'event' => 'new_qualified_lead',
'audience_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'filter' => [
'via_kind' => [
],
'engagement_type' => [
'<string>'
],
'company_id' => [
'<string>'
],
'min_warmth' => 50,
'min_fit_score' => 50,
'first_engagement_only' => true,
'pinned_only' => true,
'orbit' => [
],
'kind' => [
'<string>'
],
'status' => [
'<string>'
]
],
'is_active' => true,
'min_interval_minutes' => 0,
'send_hour_utc' => 11
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>"
],
]);
$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/integrations/{id}/rules"
payload := strings.NewReader("{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.ziplined.io/v1/integrations/{id}/rules")
.header("idempotency-key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ziplined.io/v1/integrations/{id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"newQualifiedLeads\",\n \"event\": \"new_qualified_lead\",\n \"audience_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filter\": {\n \"via_kind\": [],\n \"engagement_type\": [\n \"<string>\"\n ],\n \"company_id\": [\n \"<string>\"\n ],\n \"min_warmth\": 50,\n \"min_fit_score\": 50,\n \"first_engagement_only\": true,\n \"pinned_only\": true,\n \"orbit\": [],\n \"kind\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ]\n },\n \"is_active\": true,\n \"min_interval_minutes\": 0,\n \"send_hour_utc\": 11\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"integration_id": "<string>",
"name": "<string>",
"event": "new_engagement",
"is_active": true,
"audience_id": "<string>",
"filter": {},
"min_interval_minutes": 123,
"send_hour_utc": 123,
"watermark_at": "<string>",
"created_at": "<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>"
}
}