Create Draft Outbound

curl --request POST \
  --url https://app.puffle.ai/api/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "sender_account_ids": [
    "<string>"
  ],
  "skip_other_campaigns": true,
  "operating_hours": {},
  "daily_limit": 123,
  "stop_on_reply": true,
  "open_tracking": true,
  "signature": "<string>"
}
'

import requests

url = "https://app.puffle.ai/api/campaigns"

payload = {
    "type": "<string>",
    "name": "<string>",
    "sender_account_ids": ["<string>"],
    "skip_other_campaigns": True,
    "operating_hours": {},
    "daily_limit": 123,
    "stop_on_reply": True,
    "open_tracking": True,
    "signature": "<string>"
}
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({
    type: '<string>',
    name: '<string>',
    sender_account_ids: ['<string>'],
    skip_other_campaigns: true,
    operating_hours: {},
    daily_limit: 123,
    stop_on_reply: true,
    open_tracking: true,
    signature: '<string>'
  })
};

fetch('https://app.puffle.ai/api/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://app.puffle.ai/api/campaigns",
  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([
    'type' => '<string>',
    'name' => '<string>',
    'sender_account_ids' => [
        '<string>'
    ],
    'skip_other_campaigns' => true,
    'operating_hours' => [
        
    ],
    'daily_limit' => 123,
    'stop_on_reply' => true,
    'open_tracking' => true,
    'signature' => '<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://app.puffle.ai/api/campaigns"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\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://app.puffle.ai/api/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.puffle.ai/api/campaigns")

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  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\n}"

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

{
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "daily_limit": 4503599627370495,
    "stop_on_reply": true,
    "open_tracking": true,
    "signature": "<string>",
    "skip_other_campaigns": true,
    "operating_hours": {},
    "stats": {
      "total": 4503599627370495,
      "sent": 4503599627370495,
      "replied": 4503599627370495,
      "bounced": 4503599627370495,
      "completed": 4503599627370495,
      "timed_out": 4503599627370495,
      "connection_sent": 4503599627370495,
      "connected": 4503599627370495,
      "connections_accepted": 4503599627370495,
      "message_sent": 4503599627370495,
      "contacted": 4503599627370495
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "sequence_nodes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "position": 4503599627370495,
        "subject": "<string>",
        "body": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

api

campaigns

Create Draft Outbound

curl --request POST \
  --url https://app.puffle.ai/api/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "sender_account_ids": [
    "<string>"
  ],
  "skip_other_campaigns": true,
  "operating_hours": {},
  "daily_limit": 123,
  "stop_on_reply": true,
  "open_tracking": true,
  "signature": "<string>"
}
'

import requests

url = "https://app.puffle.ai/api/campaigns"

payload = {
    "type": "<string>",
    "name": "<string>",
    "sender_account_ids": ["<string>"],
    "skip_other_campaigns": True,
    "operating_hours": {},
    "daily_limit": 123,
    "stop_on_reply": True,
    "open_tracking": True,
    "signature": "<string>"
}
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({
    type: '<string>',
    name: '<string>',
    sender_account_ids: ['<string>'],
    skip_other_campaigns: true,
    operating_hours: {},
    daily_limit: 123,
    stop_on_reply: true,
    open_tracking: true,
    signature: '<string>'
  })
};

fetch('https://app.puffle.ai/api/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://app.puffle.ai/api/campaigns",
  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([
    'type' => '<string>',
    'name' => '<string>',
    'sender_account_ids' => [
        '<string>'
    ],
    'skip_other_campaigns' => true,
    'operating_hours' => [
        
    ],
    'daily_limit' => 123,
    'stop_on_reply' => true,
    'open_tracking' => true,
    'signature' => '<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://app.puffle.ai/api/campaigns"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\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://app.puffle.ai/api/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.puffle.ai/api/campaigns")

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  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sender_account_ids\": [\n    \"<string>\"\n  ],\n  \"skip_other_campaigns\": true,\n  \"operating_hours\": {},\n  \"daily_limit\": 123,\n  \"stop_on_reply\": true,\n  \"open_tracking\": true,\n  \"signature\": \"<string>\"\n}"

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

{
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "daily_limit": 4503599627370495,
    "stop_on_reply": true,
    "open_tracking": true,
    "signature": "<string>",
    "skip_other_campaigns": true,
    "operating_hours": {},
    "stats": {
      "total": 4503599627370495,
      "sent": 4503599627370495,
      "replied": 4503599627370495,
      "bounced": 4503599627370495,
      "completed": 4503599627370495,
      "timed_out": 4503599627370495,
      "connection_sent": 4503599627370495,
      "connected": 4503599627370495,
      "connections_accepted": 4503599627370495,
      "message_sent": 4503599627370495,
      "contacted": 4503599627370495
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "sequence_nodes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "position": 4503599627370495,
        "subject": "<string>",
        "body": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

CLI:

puffle campaign create
puffle campaign create --type <type> --name <name> --sender-account-ids <sender-account-ids> --skip-other-campaigns --operating-hours <operating-hours> --daily-limit <daily-limit> --stop-on-reply --open-tracking --signature <signature>

Overview

Creates a draft campaign-backed Outbound execution for one channel (linkedin or email) and seeds it with a two-node default sequence: either [connection_request, end] or [email, end]. The draft is not yet launchable: the email body, contacts, and any extra nodes still need to be added.

Prerequisites

You need at least one connected sender account that matches type:

Get senders: GET /api/senders?type=email or GET /api/senders?type=linkedin
If none exist, connect one first. Email setup uses Create Email Account; LinkedIn setup requires a human-operated dashboard connection flow.

Typical follow-up sequence

updateCampaign - fill in sequence_nodes (for email, set subject and body; add more steps if needed)
addLeadsToCampaign - add at least one real recipient, or use importLeadsFromListToCampaign for a saved List
getLeadsInCampaign with status=pending - confirm the intended recipients were accepted and review the count
getCampaign with id - confirm the draft has matching sender accounts and non-empty sendable nodes
Ask the human to confirm the channel, sender, recipient count, and final sequence
launchCampaign - start sending only after that explicit confirmation

AI agent notes

Name uniqueness (409). Names are unique per user. Retry with a suffix if you hit a 409.Channel-specific fields. LinkedIn-only fields (skip_other_campaigns, operating_hours) on an email draft and email-only fields (daily_limit, stop_on_reply, open_tracking, signature) on a LinkedIn draft are silently ignored, not rejected. Send only the fields that apply.Default sequence is intentionally empty. Email subject and body are empty strings. Populate them via updateCampaign or the AI message-generation flow before launch.Sender accounts must match type. A LinkedIn account id on an email draft, or vice versa, returns 400. Filter GET /api/senders by type before picking.No contacts yet. Creation seeds the sequence but adds no contacts. A launch attempt without pending contacts is rejected with 400 and { "error": "No leads in campaign" }; the Outbound remains a draft. Add recipients and re-check the pending roster before asking for launch approval.

Authorizations

Authorization

string

header

required

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

Body

application/json

type

string

name

string

sender_account_ids

string[]

skip_other_campaigns

boolean

operating_hours

object

Show child attributes

daily_limit

number

stop_on_reply

boolean

open_tracking

boolean

signature

string

{key}

any

Response

Outbound created as a draft with its seeded sequence.

campaign

object

required

Show child attributes

​Overview

​Prerequisites

​Typical follow-up sequence

​AI agent notes

Authorizations

Body

Response

Overview

Prerequisites

Typical follow-up sequence

AI agent notes