Skip to main content
POST
/
campaigns
cURL
curl --request POST \
  --url https://api.puretalk.ai/api/campaigns \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "My Campaign",
  "start_date": "2021-01-01",
  "end_date": "2021-01-01",
  "ai_assistant_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "call",
  "leads": [
    {
      "to_number": "+1234567890",
      "variables": [
        {
          "var_name": "name",
          "var_value": "John Doe"
        }
      ]
    }
  ]
}
'
import requests

url = "https://api.puretalk.ai/api/campaigns"

payload = {
"name": "My Campaign",
"start_date": "2021-01-01",
"end_date": "2021-01-01",
"ai_assistant_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "call",
"leads": [
{
"to_number": "+1234567890",
"variables": [
{
"var_name": "name",
"var_value": "John Doe"
}
]
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Campaign',
start_date: '2021-01-01',
end_date: '2021-01-01',
ai_assistant_id: '123e4567-e89b-12d3-a456-426614174000',
type: 'call',
leads: [
{
to_number: '+1234567890',
variables: [{var_name: 'name', var_value: 'John Doe'}]
}
]
})
};

fetch('https://api.puretalk.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://api.puretalk.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([
'name' => 'My Campaign',
'start_date' => '2021-01-01',
'end_date' => '2021-01-01',
'ai_assistant_id' => '123e4567-e89b-12d3-a456-426614174000',
'type' => 'call',
'leads' => [
[
'to_number' => '+1234567890',
'variables' => [
[
'var_name' => 'name',
'var_value' => 'John Doe'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.puretalk.ai/api/campaigns"

payload := strings.NewReader("{\n \"name\": \"My Campaign\",\n \"start_date\": \"2021-01-01\",\n \"end_date\": \"2021-01-01\",\n \"ai_assistant_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"call\",\n \"leads\": [\n {\n \"to_number\": \"+1234567890\",\n \"variables\": [\n {\n \"var_name\": \"name\",\n \"var_value\": \"John Doe\"\n }\n ]\n }\n ]\n}")

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

req.Header.Add("X-API-KEY", "<api-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.puretalk.ai/api/campaigns")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Campaign\",\n \"start_date\": \"2021-01-01\",\n \"end_date\": \"2021-01-01\",\n \"ai_assistant_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"call\",\n \"leads\": [\n {\n \"to_number\": \"+1234567890\",\n \"variables\": [\n {\n \"var_name\": \"name\",\n \"var_value\": \"John Doe\"\n }\n ]\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Campaign\",\n \"start_date\": \"2021-01-01\",\n \"end_date\": \"2021-01-01\",\n \"ai_assistant_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"call\",\n \"leads\": [\n {\n \"to_number\": \"+1234567890\",\n \"variables\": [\n {\n \"var_name\": \"name\",\n \"var_value\": \"John Doe\"\n }\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "msg": "Campaign created successfully",
  "err": false,
  "results": {
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}
{
"err": false,
"msg": "Error message"
}

Authorizations

X-API-KEY
string
header
required

Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.

Body

application/json
name
string
required

Name of the campaign

Example:

"My Campaign"

start_date
string
required

Start date of the campaign

Example:

"2021-01-01"

end_date
string
required

End date of the campaign

Example:

"2021-01-01"

ai_assistant_id
string
required

ID of the AI assistant to use for the campaign

Example:

"123e4567-e89b-12d3-a456-426614174000"

type
string
required

Type of the campaign

Example:

"call"

leads
object[]
required

Response

Campaign created

msg
string

Message from the API

Example:

"Campaign created successfully"

err
boolean

Indicates if the response is an error

Example:

false

results
object