Update campaign - Botdog API

Update campaign

curl --request PATCH \
  --url https://api.botdog.co/v1/campaigns/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "startDate": "<string>",
  "endDate": "<string>"
}
'

import requests

url = "https://api.botdog.co/v1/campaigns/{id}"

payload = {
    "name": "<string>",
    "startDate": "<string>",
    "endDate": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', startDate: '<string>', endDate: '<string>'})
};

fetch('https://api.botdog.co/v1/campaigns/{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.botdog.co/v1/campaigns/{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([
    'name' => '<string>',
    'startDate' => '<string>',
    'endDate' => '<string>'
  ]),
  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.botdog.co/v1/campaigns/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.botdog.co/v1/campaigns/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botdog.co/v1/campaigns/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}"

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q4 Sales Outreach",
  "status": "ACTIVE",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerEmail": "john.doe@example.com",
  "createdAt": "2023-09-15T12:00:00Z",
  "updatedAt": "2023-09-16T14:30:00Z",
  "startDate": "2023-09-15T12:00:00Z",
  "endDate": "2023-09-15T12:00:00Z"
}

PATCH

/

v1

/

campaigns

/

{id}

Update campaign

curl --request PATCH \
  --url https://api.botdog.co/v1/campaigns/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "startDate": "<string>",
  "endDate": "<string>"
}
'

import requests

url = "https://api.botdog.co/v1/campaigns/{id}"

payload = {
    "name": "<string>",
    "startDate": "<string>",
    "endDate": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', startDate: '<string>', endDate: '<string>'})
};

fetch('https://api.botdog.co/v1/campaigns/{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.botdog.co/v1/campaigns/{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([
    'name' => '<string>',
    'startDate' => '<string>',
    'endDate' => '<string>'
  ]),
  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.botdog.co/v1/campaigns/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.botdog.co/v1/campaigns/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botdog.co/v1/campaigns/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\"\n}"

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q4 Sales Outreach",
  "status": "ACTIVE",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerEmail": "john.doe@example.com",
  "createdAt": "2023-09-15T12:00:00Z",
  "updatedAt": "2023-09-16T14:30:00Z",
  "startDate": "2023-09-15T12:00:00Z",
  "endDate": "2023-09-15T12:00:00Z"
}

Authorizations

x-api-key

string

header

default:bd_live_your_key_here

required

Path Parameters

id

string

required

Body

application/json

name

string

The campaign name

startDate

string

When the campaign should start (ISO 8601)

endDate

string

When the campaign should end (ISO 8601)

Response

id

string

required

The unique identifier of the campaign

Example:

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

name

string

required

The name of the campaign

Example:

"Q4 Sales Outreach"

status

enum<string>

required

The current status of the campaign

Available options:

ACTIVE,

PAUSED,

ARCHIVED,

COMPLETED,

CREATED

Example:

"ACTIVE"

ownerId

string

required

The ID of the user who owns this campaign

Example:

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

ownerEmail

string

required

The email of the user who owns this campaign

Example:

"john.doe@example.com"

createdAt

string<date-time>

required

The date the campaign was created

Example:

"2023-09-15T12:00:00Z"

updatedAt

string<date-time>

required

The date the campaign was last updated

Example:

"2023-09-16T14:30:00Z"

startDate

string<date-time>

required

The date the campaign will start

Example:

"2023-09-15T12:00:00Z"

endDate

string<date-time>

required

The date the campaign will end

Example:

"2023-09-15T12:00:00Z"

Delete campaign

Archive campaign