Disable campaign
curl --request POST \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/disable \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/disable"
payload = {}
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({})
};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/disable', 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://inboxapp.com/api/v1/campaigns/{campaignId}/disable",
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([
]),
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://inboxapp.com/api/v1/campaigns/{campaignId}/disable"
payload := strings.NewReader("{}")
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://inboxapp.com/api/v1/campaigns/{campaignId}/disable")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/disable")
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 = "{}"
response = http.request(request)
puts response.read_body{
"id": "usdjpdql3f90seqk13rwuo7z",
"name": "Q1 DM outreach",
"description": "Targeting SaaS founders from the import list",
"status": "paused",
"enabled": true,
"dryRun": false,
"targetsCount": 1200,
"contactedCount": 340,
"repliesCount": 42,
"completionRate": 0.28,
"replyRate": 0.12,
"hourlyMessageRate": 8,
"scheduleTimezone": "America/New_York",
"scheduleHours": {
"1": {
"start": 540,
"end": 1020
},
"2": {
"start": 540,
"end": 1020
},
"3": {
"start": 540,
"end": 1020
},
"4": {
"start": 540,
"end": 1020
},
"5": {
"start": 540,
"end": 1020
}
},
"isBuildingPlan": false,
"isSyncing": false,
"scopeAssessedCount": 1150,
"accountLinkIds": [
"r4t9vw15jm6bn3yxcf2dq8ek"
],
"rules": {
"syncedLists": [
{
"listId": "l44e15irdq4db30i77cgphhx",
"listName": "Hot Leads Q1",
"columnMapping": {
"custom_q5cktl47a6pqa74eu06fz89v": "custom_m8r2xj93hd5bk0atcw7oe4fp"
}
}
],
"excludedLists": [
{
"listId": "l44e15irdq4db30i77cgphhx",
"listName": "Do Not Contact"
}
],
"excludeContacted": false,
"excludeMutuals": false
},
"sequence": {
"version": 2,
"steps": [
{
"id": "w3x4y5z6a7b8c9d0e1f2g3h4",
"rank": 0,
"type": "message",
"data": {
"segments": [
{
"type": "static",
"text": "Hey "
},
{
"type": "variable",
"name": "first-name",
"fallback": "there"
},
{
"type": "static",
"text": ", I noticed you're building in the SaaS space. Would love to connect and share some ideas — open to a quick chat?"
}
]
}
},
{
"id": "a1b2c3d4e5f6g7h8i9j0k1l2",
"rank": 1,
"type": "delay",
"data": {
"delaySeconds": 86400,
"unit": "days"
}
},
{
"id": "m3n4o5p6q7r8s9t0u1v2w3x4",
"rank": 2,
"type": "message",
"data": {
"segments": [
{
"type": "static",
"text": "Hey, just following up on my last message — would love to hear your thoughts if you have a moment!"
}
]
}
}
]
},
"automations": [
{
"id": "j7k8l9m0n1o2p3q4r5s6t7u8",
"trigger": "prospectFirstReply",
"action": "setStatus",
"actionData": {
"statusId": "m3n4o5p6q7r8s9t0u1v2w3x4"
},
"enabled": true
}
],
"createdAt": "2025-06-01T12:00:00.000Z",
"updatedAt": "2025-06-02T09:30:00.000Z",
"pausedAt": "2025-06-05T16:00:00.000Z",
"completedAt": null,
"lastStartedAt": "2025-06-03T09:00:00.000Z"
}Campaigns
Disable campaign
Disable message dispatch for a campaign. This transitions the campaign to paused status. Messages in flight may still be delivered. To re-enable, use Enable campaign.
POST
/
campaigns
/
{campaignId}
/
disable
Disable campaign
curl --request POST \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/disable \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/disable"
payload = {}
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({})
};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/disable', 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://inboxapp.com/api/v1/campaigns/{campaignId}/disable",
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([
]),
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://inboxapp.com/api/v1/campaigns/{campaignId}/disable"
payload := strings.NewReader("{}")
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://inboxapp.com/api/v1/campaigns/{campaignId}/disable")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/disable")
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 = "{}"
response = http.request(request)
puts response.read_body{
"id": "usdjpdql3f90seqk13rwuo7z",
"name": "Q1 DM outreach",
"description": "Targeting SaaS founders from the import list",
"status": "paused",
"enabled": true,
"dryRun": false,
"targetsCount": 1200,
"contactedCount": 340,
"repliesCount": 42,
"completionRate": 0.28,
"replyRate": 0.12,
"hourlyMessageRate": 8,
"scheduleTimezone": "America/New_York",
"scheduleHours": {
"1": {
"start": 540,
"end": 1020
},
"2": {
"start": 540,
"end": 1020
},
"3": {
"start": 540,
"end": 1020
},
"4": {
"start": 540,
"end": 1020
},
"5": {
"start": 540,
"end": 1020
}
},
"isBuildingPlan": false,
"isSyncing": false,
"scopeAssessedCount": 1150,
"accountLinkIds": [
"r4t9vw15jm6bn3yxcf2dq8ek"
],
"rules": {
"syncedLists": [
{
"listId": "l44e15irdq4db30i77cgphhx",
"listName": "Hot Leads Q1",
"columnMapping": {
"custom_q5cktl47a6pqa74eu06fz89v": "custom_m8r2xj93hd5bk0atcw7oe4fp"
}
}
],
"excludedLists": [
{
"listId": "l44e15irdq4db30i77cgphhx",
"listName": "Do Not Contact"
}
],
"excludeContacted": false,
"excludeMutuals": false
},
"sequence": {
"version": 2,
"steps": [
{
"id": "w3x4y5z6a7b8c9d0e1f2g3h4",
"rank": 0,
"type": "message",
"data": {
"segments": [
{
"type": "static",
"text": "Hey "
},
{
"type": "variable",
"name": "first-name",
"fallback": "there"
},
{
"type": "static",
"text": ", I noticed you're building in the SaaS space. Would love to connect and share some ideas — open to a quick chat?"
}
]
}
},
{
"id": "a1b2c3d4e5f6g7h8i9j0k1l2",
"rank": 1,
"type": "delay",
"data": {
"delaySeconds": 86400,
"unit": "days"
}
},
{
"id": "m3n4o5p6q7r8s9t0u1v2w3x4",
"rank": 2,
"type": "message",
"data": {
"segments": [
{
"type": "static",
"text": "Hey, just following up on my last message — would love to hear your thoughts if you have a moment!"
}
]
}
}
]
},
"automations": [
{
"id": "j7k8l9m0n1o2p3q4r5s6t7u8",
"trigger": "prospectFirstReply",
"action": "setStatus",
"actionData": {
"statusId": "m3n4o5p6q7r8s9t0u1v2w3x4"
},
"enabled": true
}
],
"createdAt": "2025-06-01T12:00:00.000Z",
"updatedAt": "2025-06-02T09:30:00.000Z",
"pausedAt": "2025-06-05T16:00:00.000Z",
"completedAt": null,
"lastStartedAt": "2025-06-03T09:00:00.000Z"
}Authorizations
Body
application/json
The body is of type object.
Response
200 - application/json
OK
Sending windows per day of week where key 0 is Sunday and values are minute-of-day start/end ranges
Show child attributes
Show child attributes
Example:
{
"1": { "start": 540, "end": 1020 },
"2": { "start": 540, "end": 1020 },
"3": { "start": 540, "end": 1020 },
"4": { "start": 540, "end": 1020 },
"5": { "start": 540, "end": 1020 }
}
Number of leads that have been assessed for eligibility. If this number is less than targetsCount, some leads are still being evaluated for reachability and the target count may increase. Once scopeAssessedCount equals targetsCount, the final scope of the campaign is known.
Required range:
0 <= x <= 9007199254740991Example:
1150
Was this page helpful?