campaigns

create a campaign

dial every contact of an audience with a deployed agent (UUID or handle), from one of your own numbers (phoneLineKind rented or sip_trunk with phoneLineId), up to maxConcurrentCalls at a time. retryEnabled redials contacts who don’t pick up after retryDelayMinutes (15, 20, 30 or 60), up to maxRetries (1–6). scheduledAt (up to 90 days ahead) starts it later; left out, it starts now. contextColumns picks the audience columns appended to the agent’s prompt on every call (left out, the audience’s own choice; [], none). every call is billed and recorded like any phone call.

POST

campaigns

create a campaign

curl --request POST \
  --url https://silk-api.rumik.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Diwali offer",
  "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
  "agentId": "ua_fe3277d8",
  "phoneLineKind": "sip_trunk",
  "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
  "contextColumns": [
    {
      "column": "city",
      "description": "where they live"
    }
  ],
  "maxConcurrentCalls": 2,
  "retryEnabled": true,
  "retryDelayMinutes": 15,
  "maxRetries": 2,
  "scheduledAt": null
}
'

import requests

url = "https://silk-api.rumik.ai/v1/campaigns"

payload = {
    "name": "Diwali offer",
    "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
    "agentId": "ua_fe3277d8",
    "phoneLineKind": "sip_trunk",
    "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
    "contextColumns": [
        {
            "column": "city",
            "description": "where they live"
        }
    ],
    "maxConcurrentCalls": 2,
    "retryEnabled": True,
    "retryDelayMinutes": 15,
    "maxRetries": 2,
    "scheduledAt": None
}
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({
    name: 'Diwali offer',
    audienceId: '01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f',
    agentId: 'ua_fe3277d8',
    phoneLineKind: 'sip_trunk',
    phoneLineId: '019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b',
    contextColumns: [{column: 'city', description: 'where they live'}],
    maxConcurrentCalls: 2,
    retryEnabled: true,
    retryDelayMinutes: 15,
    maxRetries: 2,
    scheduledAt: null
  })
};

fetch('https://silk-api.rumik.ai/v1/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://silk-api.rumik.ai/v1/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' => 'Diwali offer',
    'audienceId' => '01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f',
    'agentId' => 'ua_fe3277d8',
    'phoneLineKind' => 'sip_trunk',
    'phoneLineId' => '019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b',
    'contextColumns' => [
        [
                'column' => 'city',
                'description' => 'where they live'
        ]
    ],
    'maxConcurrentCalls' => 2,
    'retryEnabled' => true,
    'retryDelayMinutes' => 15,
    'maxRetries' => 2,
    'scheduledAt' => null
  ]),
  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://silk-api.rumik.ai/v1/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\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://silk-api.rumik.ai/v1/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/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  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\n}"

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

{
  "id": "01a0c165-7093-72a4-df10-2b3c4d5e6f70",
  "name": "Diwali offer",
  "description": null,
  "status": "running",
  "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
  "audienceName": "September leads",
  "contextColumns": [
    {
      "column": "city",
      "description": "where they live"
    }
  ],
  "userAgentId": "019f6a2e-7c1d-7b3a-9e4f-1a2b3c4d5e6f",
  "agentName": "acme support",
  "phoneLineKind": "sip_trunk",
  "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
  "fromNumber": "+918035763212",
  "maxConcurrentCalls": 2,
  "retryEnabled": true,
  "retryDelayMinutes": 15,
  "maxRetries": 2,
  "scheduledAt": null,
  "startedAt": "2026-10-01T09:05:00Z",
  "completedAt": null,
  "cancelledAt": null,
  "lastError": null,
  "notice": null,
  "noticeAt": null,
  "stats": {
    "total": 120,
    "pending": 95,
    "dialing": 1,
    "inProgress": 1,
    "retryWaiting": 3,
    "completed": 18,
    "failed": 2,
    "skipped": 0
  },
  "createdAt": "2026-10-01T09:05:00Z",
  "updatedAt": "2026-10-01T09:20:00Z"
}

Authorizations

Authorization

string

header

required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

application/json

the body of POST /v1/campaigns.

name

string

required

the campaign's name, up to 120 characters.

Maximum string length: 120

audienceId

string<uuid>

required

the audience to call.

phoneLineKind

enum<string>

required

rented (a number rented through rumik) or sip_trunk (one of your SIP trunks). see GET /v1/campaigns/phone-lines.

Available options:

rented,

sip_trunk,

platform

agentId

string

required

the agent making the calls: its UUID or ua_… handle. must be deployed.

Required string length: 1 - 64

description

string | null

Maximum string length: 1000

phoneLineId

string<uuid> | null

the rented number's or SIP trunk's id.

contextColumns

ContextColumn · object[] | null

the audience columns appended to the agent's prompt on every call, each with a description. left out, the audience's own choice; [], none.

Show child attributes

maxConcurrentCalls

integer

default:1

calls kept live at once, up to your account's limit (maxConcurrentCalls of GET /v1/campaigns/phone-lines). default 1.

Required range: 1 <= x <= 50

retryEnabled

boolean

default:false

redial a contact who didn't pick up.

retryDelayMinutes

integer

default:15

minutes before a redial: 15, 20, 30 or 60.

Required range: x >= 1

maxRetries

integer

default:1

redials per contact, 1–6.

Required range: 0 <= x <= 6

scheduledAt

string<date-time> | null

ISO 8601 time to start, up to 90 days ahead. left out or null, it starts now.

Response

created.

an outbound campaign, with live counts of its contacts by state.

string<uuid>

required

name

string

required

description

string | null

required

status

string

required

audienceId

string<uuid> | null

required

audienceName

string

required

userAgentId

string<uuid> | null

required

agentName

string | null

required

phoneLineKind

string

required

phoneLineId

string<uuid> | null

required

fromNumber

string | null

required

maxConcurrentCalls

integer

required

retryEnabled

boolean

required

retryDelayMinutes

integer

required

maxRetries

integer

required

scheduledAt

string<date-time> | null

required

startedAt

string<date-time> | null

required

completedAt

string<date-time> | null

required

cancelledAt

string<date-time> | null

required

lastError

string | null

required

notice

string | null

required

noticeAt

string<date-time> | null

required

stats

CampaignStats · object

required

How many of the campaign's contacts sit in each state.

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

contextColumns

ContextColumn · object[] | null

Show child attributes

create a campaign

curl --request POST \
  --url https://silk-api.rumik.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Diwali offer",
  "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
  "agentId": "ua_fe3277d8",
  "phoneLineKind": "sip_trunk",
  "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
  "contextColumns": [
    {
      "column": "city",
      "description": "where they live"
    }
  ],
  "maxConcurrentCalls": 2,
  "retryEnabled": true,
  "retryDelayMinutes": 15,
  "maxRetries": 2,
  "scheduledAt": null
}
'

import requests

url = "https://silk-api.rumik.ai/v1/campaigns"

payload = {
    "name": "Diwali offer",
    "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
    "agentId": "ua_fe3277d8",
    "phoneLineKind": "sip_trunk",
    "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
    "contextColumns": [
        {
            "column": "city",
            "description": "where they live"
        }
    ],
    "maxConcurrentCalls": 2,
    "retryEnabled": True,
    "retryDelayMinutes": 15,
    "maxRetries": 2,
    "scheduledAt": None
}
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({
    name: 'Diwali offer',
    audienceId: '01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f',
    agentId: 'ua_fe3277d8',
    phoneLineKind: 'sip_trunk',
    phoneLineId: '019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b',
    contextColumns: [{column: 'city', description: 'where they live'}],
    maxConcurrentCalls: 2,
    retryEnabled: true,
    retryDelayMinutes: 15,
    maxRetries: 2,
    scheduledAt: null
  })
};

fetch('https://silk-api.rumik.ai/v1/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://silk-api.rumik.ai/v1/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' => 'Diwali offer',
    'audienceId' => '01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f',
    'agentId' => 'ua_fe3277d8',
    'phoneLineKind' => 'sip_trunk',
    'phoneLineId' => '019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b',
    'contextColumns' => [
        [
                'column' => 'city',
                'description' => 'where they live'
        ]
    ],
    'maxConcurrentCalls' => 2,
    'retryEnabled' => true,
    'retryDelayMinutes' => 15,
    'maxRetries' => 2,
    'scheduledAt' => null
  ]),
  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://silk-api.rumik.ai/v1/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\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://silk-api.rumik.ai/v1/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/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  \"name\": \"Diwali offer\",\n  \"audienceId\": \"01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f\",\n  \"agentId\": \"ua_fe3277d8\",\n  \"phoneLineKind\": \"sip_trunk\",\n  \"phoneLineId\": \"019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b\",\n  \"contextColumns\": [\n    {\n      \"column\": \"city\",\n      \"description\": \"where they live\"\n    }\n  ],\n  \"maxConcurrentCalls\": 2,\n  \"retryEnabled\": true,\n  \"retryDelayMinutes\": 15,\n  \"maxRetries\": 2,\n  \"scheduledAt\": null\n}"

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

{
  "id": "01a0c165-7093-72a4-df10-2b3c4d5e6f70",
  "name": "Diwali offer",
  "description": null,
  "status": "running",
  "audienceId": "01a0b054-6f82-7193-ce0f-1a2b3c4d5e6f",
  "audienceName": "September leads",
  "contextColumns": [
    {
      "column": "city",
      "description": "where they live"
    }
  ],
  "userAgentId": "019f6a2e-7c1d-7b3a-9e4f-1a2b3c4d5e6f",
  "agentName": "acme support",
  "phoneLineKind": "sip_trunk",
  "phoneLineId": "019f7c10-2b4e-7d5f-8a6b-7c8d9e0f1a2b",
  "fromNumber": "+918035763212",
  "maxConcurrentCalls": 2,
  "retryEnabled": true,
  "retryDelayMinutes": 15,
  "maxRetries": 2,
  "scheduledAt": null,
  "startedAt": "2026-10-01T09:05:00Z",
  "completedAt": null,
  "cancelledAt": null,
  "lastError": null,
  "notice": null,
  "noticeAt": null,
  "stats": {
    "total": 120,
    "pending": 95,
    "dialing": 1,
    "inProgress": 1,
    "retryWaiting": 3,
    "completed": 18,
    "failed": 2,
    "skipped": 0
  },
  "createdAt": "2026-10-01T09:05:00Z",
  "updatedAt": "2026-10-01T09:20:00Z"
}

documentation

sdk

integrations

cookbook

api reference

create a campaign

Authorizations

Body

Response