Update Email Campaign

curl --request PATCH \
  --url https://api.getoutbox.ai/email/campaigns/{campaign_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_identity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "name": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "allowed_windows": "<unknown>",
  "stop_on_reply": true,
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.getoutbox.ai/email/campaigns/{campaign_id}/"

payload = {
    "sender_identity_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "name": "<string>",
    "description": "<string>",
    "timezone": "<string>",
    "allowed_windows": "<unknown>",
    "stop_on_reply": True,
    "is_deleted": True,
    "created_at": "2023-11-07T05:31:56Z",
    "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sender_identity_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    name: '<string>',
    description: '<string>',
    timezone: '<string>',
    allowed_windows: '<unknown>',
    stop_on_reply: true,
    is_deleted: true,
    created_at: '2023-11-07T05:31:56Z',
    company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    created_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    responder_agent: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getoutbox.ai/email/campaigns/{campaign_id}/', 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.getoutbox.ai/email/campaigns/{campaign_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'sender_identity_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'name' => '<string>',
    'description' => '<string>',
    'timezone' => '<string>',
    'allowed_windows' => '<unknown>',
    'stop_on_reply' => true,
    'is_deleted' => true,
    'created_at' => '2023-11-07T05:31:56Z',
    'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'created_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'responder_agent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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.getoutbox.ai/email/campaigns/{campaign_id}/"

	payload := strings.NewReader("{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.getoutbox.ai/email/campaigns/{campaign_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoutbox.ai/email/campaigns/{campaign_id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "step_order": 1,
      "subject": "<string>",
      "body_html": "<string>",
      "body_text": "<string>",
      "delay_minutes": 1073741823,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sender_identities": "<string>",
  "sent_count": "<string>",
  "unique_opens": "<string>",
  "unique_clicks": "<string>",
  "replies": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_identity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "timezone": "<string>",
  "allowed_windows": "<unknown>",
  "stop_on_reply": true,
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

PATCH

campaigns

{campaign_id}

Update Email Campaign

curl --request PATCH \
  --url https://api.getoutbox.ai/email/campaigns/{campaign_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_identity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "name": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "allowed_windows": "<unknown>",
  "stop_on_reply": true,
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.getoutbox.ai/email/campaigns/{campaign_id}/"

payload = {
    "sender_identity_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "name": "<string>",
    "description": "<string>",
    "timezone": "<string>",
    "allowed_windows": "<unknown>",
    "stop_on_reply": True,
    "is_deleted": True,
    "created_at": "2023-11-07T05:31:56Z",
    "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sender_identity_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    name: '<string>',
    description: '<string>',
    timezone: '<string>',
    allowed_windows: '<unknown>',
    stop_on_reply: true,
    is_deleted: true,
    created_at: '2023-11-07T05:31:56Z',
    company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    created_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    responder_agent: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getoutbox.ai/email/campaigns/{campaign_id}/', 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.getoutbox.ai/email/campaigns/{campaign_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'sender_identity_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'name' => '<string>',
    'description' => '<string>',
    'timezone' => '<string>',
    'allowed_windows' => '<unknown>',
    'stop_on_reply' => true,
    'is_deleted' => true,
    'created_at' => '2023-11-07T05:31:56Z',
    'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'created_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'responder_agent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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.getoutbox.ai/email/campaigns/{campaign_id}/"

	payload := strings.NewReader("{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.getoutbox.ai/email/campaigns/{campaign_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoutbox.ai/email/campaigns/{campaign_id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sender_identity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"allowed_windows\": \"<unknown>\",\n  \"stop_on_reply\": true,\n  \"is_deleted\": true,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"responder_agent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "step_order": 1,
      "subject": "<string>",
      "body_html": "<string>",
      "body_text": "<string>",
      "delay_minutes": 1073741823,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sender_identities": "<string>",
  "sent_count": "<string>",
  "unique_opens": "<string>",
  "unique_clicks": "<string>",
  "replies": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_identity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "timezone": "<string>",
  "allowed_windows": "<unknown>",
  "stop_on_reply": true,
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responder_agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Body

sender_identity_ids

string<uuid>[]

Optional sender pool for random campaign sending.

name

string

Required string length: 1 - 255

status

enum<string>

draft - Draft
active - Active
paused - Paused
completed - Completed
cancelled - Cancelled

Available options:

draft,

active,

paused,

completed,

cancelled

description

string

timezone

string

Maximum string length: 64

allowed_windows

any

stop_on_reply

boolean

is_deleted

boolean

created_at

string<date-time>

company

string<uuid>

workflow

string<uuid> | null

created_by

string<uuid> | null

responder_agent

string<uuid> | null

Response

string<uuid>

required

read-only

steps

object[]

required

read-only

Show child attributes

sender_identities

string

required

read-only

sent_count

string

required

read-only

unique_opens

string

required

read-only

unique_clicks

string

required

read-only

replies

string

required

read-only

name

string

required

Maximum string length: 255

updated_at

string<date-time>

required

read-only

company

string<uuid>

required

sender_identity_ids

string<uuid>[]

Optional sender pool for random campaign sending.

status

enum<string>

draft - Draft
active - Active
paused - Paused
completed - Completed
cancelled - Cancelled

Available options:

draft,

active,

paused,

completed,

cancelled

description

string

timezone

string

Maximum string length: 64

allowed_windows

any

stop_on_reply

boolean

is_deleted

boolean

created_at

string<date-time>

workflow

string<uuid> | null

created_by

string<uuid> | null

responder_agent

string<uuid> | null

Create Email Campaign Delete Email Campaign

⌘I

API Documentation

Analytics

Agent Endpoints

Chat & Call Endpoints

Call Logs

Chat Logs

Transcripts

Call Queue

Agent Files

Agent Integrations

Agent Tools

Tools

Contact Endpoints

Conversation Endpoints

Send Messages

Workflows

CRM Opportunities

Company Settings

Company Staff Management

Company Phone Numbers

Agency Settings

Agency Companies

Agency Phone Numbers

Email Campaigns

Email Providers, Domains & Senders

Update Email Campaign

Authorizations

Path Parameters

Body

Response