Advertise

POST

advertise

Advertise

curl --request POST \
  --url https://api.darwin.so/api/v3/advertise \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "action": "create",
  "agentId": "agent-from-publish-agent",
  "operationId": "operation-from-get-operation",
  "operationRevision": 1,
  "name": "Weather conversations",
  "billingEvent": "CONVERSATIONS",
  "budgetCents": 5000
}
'

import requests

url = "https://api.darwin.so/api/v3/advertise"

payload = {
    "action": "create",
    "agentId": "agent-from-publish-agent",
    "operationId": "operation-from-get-operation",
    "operationRevision": 1,
    "name": "Weather conversations",
    "billingEvent": "CONVERSATIONS",
    "budgetCents": 5000
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: 'create',
    agentId: 'agent-from-publish-agent',
    operationId: 'operation-from-get-operation',
    operationRevision: 1,
    name: 'Weather conversations',
    billingEvent: 'CONVERSATIONS',
    budgetCents: 5000
  })
};

fetch('https://api.darwin.so/api/v3/advertise', 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.darwin.so/api/v3/advertise",
  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([
    'action' => 'create',
    'agentId' => 'agent-from-publish-agent',
    'operationId' => 'operation-from-get-operation',
    'operationRevision' => 1,
    'name' => 'Weather conversations',
    'billingEvent' => 'CONVERSATIONS',
    'budgetCents' => 5000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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.darwin.so/api/v3/advertise"

	payload := strings.NewReader("{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.darwin.so/api/v3/advertise")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/advertise")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}"

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

{
  "campaign": {
    "campaignId": "<string>",
    "agentId": "<string>",
    "operationId": "<string>",
    "operationRevision": 0,
    "revision": 0,
    "status": "DRAFT",
    "name": "<string>",
    "billingEvent": "IMPRESSIONS",
    "currency": "USD",
    "budgetCents": 0,
    "targeting": "<unknown>",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "submittedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "delivery": {
      "status": "NOT_ACTIVE",
      "impressions": null,
      "conversations": null,
      "conversions": null,
      "spendCents": null
    }
  }
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Choose action: create, update, submit, pause, or get. Existing campaign request shapes are preserved. For get, supply campaignId; it requires advertising:read. Mutations require advertising:write and Idempotency-Key. Updates, submission, and pause require expectedRevision. Submission requests review; it does not activate delivery or authorize spending. This endpoint accepts explicit commands. Conversational management threads are not available yet. The existing campaign read route remains compatible.

Authorizations

x-api-key

string

header

required

Headers

Idempotency-Key

string

required

Stable key for this exact mutation. Reusing it with different input returns 409.

Required string length: 1 - 200

Body

application/json

Option 1
Option 2
Option 3
Option 4

action

string

required

Allowed value: "create"

agentId

string

required

Required string length: 1 - 200

operationId

string

required

Required string length: 1 - 200

operationRevision

integer

required

Required range: 1 <= x <= 2147483647

name

string

required

Required string length: 1 - 160

billingEvent

enum<string>

required

Available options:

IMPRESSIONS,

CONVERSATIONS,

CONVERSIONS

budgetCents

integer

required

Required range: 1 <= x <= 1000000000

currency

string

default:USD

Allowed value: "USD"

startsAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

endsAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

targeting

object

Show child attributes

Response

Current owner-scoped result. A mutation retry returns its saved response.

campaign

object

required

Show child attributes

Last modified on November 1, 2026

Advertise

curl --request POST \
  --url https://api.darwin.so/api/v3/advertise \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "action": "create",
  "agentId": "agent-from-publish-agent",
  "operationId": "operation-from-get-operation",
  "operationRevision": 1,
  "name": "Weather conversations",
  "billingEvent": "CONVERSATIONS",
  "budgetCents": 5000
}
'

import requests

url = "https://api.darwin.so/api/v3/advertise"

payload = {
    "action": "create",
    "agentId": "agent-from-publish-agent",
    "operationId": "operation-from-get-operation",
    "operationRevision": 1,
    "name": "Weather conversations",
    "billingEvent": "CONVERSATIONS",
    "budgetCents": 5000
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: 'create',
    agentId: 'agent-from-publish-agent',
    operationId: 'operation-from-get-operation',
    operationRevision: 1,
    name: 'Weather conversations',
    billingEvent: 'CONVERSATIONS',
    budgetCents: 5000
  })
};

fetch('https://api.darwin.so/api/v3/advertise', 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.darwin.so/api/v3/advertise",
  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([
    'action' => 'create',
    'agentId' => 'agent-from-publish-agent',
    'operationId' => 'operation-from-get-operation',
    'operationRevision' => 1,
    'name' => 'Weather conversations',
    'billingEvent' => 'CONVERSATIONS',
    'budgetCents' => 5000
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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.darwin.so/api/v3/advertise"

	payload := strings.NewReader("{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.darwin.so/api/v3/advertise")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/advertise")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"create\",\n  \"agentId\": \"agent-from-publish-agent\",\n  \"operationId\": \"operation-from-get-operation\",\n  \"operationRevision\": 1,\n  \"name\": \"Weather conversations\",\n  \"billingEvent\": \"CONVERSATIONS\",\n  \"budgetCents\": 5000\n}"

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

{
  "campaign": {
    "campaignId": "<string>",
    "agentId": "<string>",
    "operationId": "<string>",
    "operationRevision": 0,
    "revision": 0,
    "status": "DRAFT",
    "name": "<string>",
    "billingEvent": "IMPRESSIONS",
    "currency": "USD",
    "budgetCents": 0,
    "targeting": "<unknown>",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "submittedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "delivery": {
      "status": "NOT_ACTIVE",
      "impressions": null,
      "conversations": null,
      "conversions": null,
      "spendCents": null
    }
  }
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Discover Agents

Use Agents

Create Agents

Manage Account

Authorizations

Headers

Body

Response