Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
launch
Launch Campaign
curl --request POST \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/launch \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/campaigns/{campaign_id}/launch"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/launch', 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.example.com/api/v1/campaigns/{campaign_id}/launch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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.example.com/api/v1/campaigns/{campaign_id}/launch"

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

req.Header.Add("Authorization", "Bearer <token>")

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.example.com/api/v1/campaigns/{campaign_id}/launch")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/launch")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "campaign": {
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "type": "<string>",
    "daily_limit": 123,
    "sending_window_start": "<string>",
    "sending_window_end": "<string>",
    "min_interval_seconds": 123,
    "timezone": "<string>",
    "steps_config": [
      {
        "step": 2,
        "delay_days": 1,
        "channel": "email",
        "variants": [
          {
            "label": "<string>",
            "weight": 50,
            "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "ai_personalization_enabled": true,
        "track_clicks": false,
        "message_template": "<string>"
      }
    ],
    "send_days": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "alias_ids": [
      "<string>"
    ],
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total_leads": 123,
    "processed_leads": 0,
    "launch_job_id": "<string>",
    "launch_requested_at": "2023-11-07T05:31:56Z",
    "launch_error": "<string>",
    "system_prompt": "<string>",
    "unreviewed_launch_policy": "launch_default",
    "paused_reason": "<string>",
    "playground_discovery_dismissed_at": "2023-11-07T05:31:56Z"
  },
  "summary": {
    "total_rows": 123,
    "launchable_rows": 123,
    "warning_count": 123
  },
  "warnings": []
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

campaign_id
string<uuid>
required

Response

Successful Response

Response for campaign launch (includes warnings).

campaign
CampaignResponse · object
required

Response model for campaign.

summary
LaunchSummary · object
required

Summary counts for a launch or preflight check.

warnings
LaunchWarning · object[]