List drip campaigns

Fetch drip campaigns

curl --request GET \
  --url https://api.paubox.com/v1/marketing/drip_campaigns \
  --header 'authorization: <api-key>'

const options = {method: 'GET', headers: {authorization: '<api-key>'}};

fetch('https://api.paubox.com/v1/marketing/drip_campaigns', 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.paubox.com/v1/marketing/drip_campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paubox.com/v1/marketing/drip_campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/drip_campaigns")

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

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "drip_campaign",
      "attributes": {
        "name": "<string>",
        "subscription_list_id": "<string>",
        "subscription_list_name": "<string>",
        "state": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "start_trigger": "<string>",
        "subscriber_count": 123,
        "subscriber_completed_count": 123
      }
    }
  ]
}

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

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

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

GET

drip_campaigns

Fetch drip campaigns

curl --request GET \
  --url https://api.paubox.com/v1/marketing/drip_campaigns \
  --header 'authorization: <api-key>'

const options = {method: 'GET', headers: {authorization: '<api-key>'}};

fetch('https://api.paubox.com/v1/marketing/drip_campaigns', 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.paubox.com/v1/marketing/drip_campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paubox.com/v1/marketing/drip_campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/drip_campaigns")

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

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "drip_campaign",
      "attributes": {
        "name": "<string>",
        "subscription_list_id": "<string>",
        "subscription_list_name": "<string>",
        "state": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "start_trigger": "<string>",
        "subscriber_count": 123,
        "subscriber_completed_count": 123
      }
    }
  ]
}

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

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

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

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Query Parameters

string

Regex string to search on. Compares against drip campaign name

order_by

string

default:created_at

Attribute to sort on. Default value is created_at

order

enum<string>

default:desc

Direction to sort. Default value is descending

Available options:

asc,

desc

Response

Drip campaigns data

data

object[]

Show child attributes

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Authorizations

Query Parameters

Response