Skip to main content
POST
/
squad-calls
/
squads
/
{squad_id}
/
outbound-campaign
Create Squad Outbound Campaign
curl --request POST \
  --url https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "squad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "targets": [
    {}
  ],
  "routing_strategy": "load_based",
  "concurrent_calls_per_agent": 2,
  "context": {}
}
'
import requests

url = "https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign"

payload = {
"squad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"targets": [{}],
"routing_strategy": "load_based",
"concurrent_calls_per_agent": 2,
"context": {}
}
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({
squad_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
targets: [{}],
routing_strategy: 'load_based',
concurrent_calls_per_agent: 2,
context: {}
})
};

fetch('https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign', 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/squad-calls/squads/{squad_id}/outbound-campaign",
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([
'squad_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'targets' => [
[

]
],
'routing_strategy' => 'load_based',
'concurrent_calls_per_agent' => 2,
'context' => [

]
]),
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://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign"

payload := strings.NewReader("{\n \"squad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"targets\": [\n {}\n ],\n \"routing_strategy\": \"load_based\",\n \"concurrent_calls_per_agent\": 2,\n \"context\": {}\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://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"squad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"targets\": [\n {}\n ],\n \"routing_strategy\": \"load_based\",\n \"concurrent_calls_per_agent\": 2,\n \"context\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/squad-calls/squads/{squad_id}/outbound-campaign")

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 \"squad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"targets\": [\n {}\n ],\n \"routing_strategy\": \"load_based\",\n \"concurrent_calls_per_agent\": 2,\n \"context\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

squad_id
string<uuid>
required

Body

application/json

Squad-based outbound campaign request.

squad_id
string<uuid>
required
name
string
required
Required string length: 1 - 255
targets
Targets · object[]
required
Minimum array length: 1
routing_strategy
string
default:load_based
Pattern: ^(round_robin|load_based|skill_based|priority)$
concurrent_calls_per_agent
integer
default:2
Required range: 1 <= x <= 5
context
Context · object | null

Response

Successful Response