Create a campaign

POST/martech/{connection_id}/campaign

Parameters

Payload

idstring

Unique identifier for the campaign

created_atdate-time

When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Campaign nametitle

typestring

Campaign type (e.g., regular, automation, ab_test)

status enum

Valid values:

"DRAFT"

"SCHEDULED"

"SENDING"

"SENT"

"CANCELLED"

"PAUSED"

"ARCHIVED"

"OTHER"

Campaign status

list_idsstring array

Associated listaudience IDs

subject_linestring

Email subject line

preview_textstring

Email preview text

from_namestring

Sender name

from_emailstring

Sender email address

reply_to_emailstring

Reply-to email address

send_atdate-time

Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

raw

Raw data from integration

Returns

MarketingCampaign

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the campaign
`created_at`	string (date-time)	No	When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	Campaign nametitle
`type`	string	No	Campaign type (e.g., regular, automation, ab_test)
`status`	enum	No	Campaign status Values: `DRAFT`, `SCHEDULED`, `SENDING`, `SENT`, `CANCELLED`, `PAUSED`, `ARCHIVED`, `OTHER`
`list_ids`	string[]	No	Associated listaudience IDs
`subject_line`	string	No	Email subject line
`preview_text`	string	No	Email preview text
`from_name`	string	No	Sender name
`from_email`	string	No	Sender email address
`reply_to_email`	string	No	Reply-to email address
`send_at`	string (date-time)	No	Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.martech.createMartechCampaign({ connectionId, martechCampaign: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw=")

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

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request POST \
  --url 'https://api.unified.to/martech/5de520f96e439b002043d8dc/campaign?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?