About this API
Creates a new email campaign in DRAFT status. The from_email domain must match a verified (ACTIVE) sending identity for the user. Target groups must belong to the user.
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Authorization: Bearer <TOKEN>YOUR_ACCESS_TOKENRequest Body
Send a application/json payload. Replace placeholder values with data from your integration.
Top-Level Fields
namestringRequiredName of the campaign (required).contentstringNot specifiedHTML content for the campaign email.settingsobjectNot specifiedAdditional campaign settings as a JSON object.from_namestringNot specifiedDisplay name for the sender.from_emailstringNot specifiedFrom email address. Domain must match a verified (ACTIVE) sending identity for the user.template_idstringNot specifiedID of the email template to use for this campaign (optional).preview_textstringNot specifiedPreview text shown in email clients (max 255 characters).scheduled_atstringNot specifiedISO date string for when to schedule the campaign (must be a future date).subject_linestringNot specifiedSubject line for the campaign email (max 998 characters).target_groupsarrayNot specifiedArray of group IDs to target with this campaign. All groups must belong to the user.reply_to_emailstringNot specifiedReply-to email address.{}
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Summer Sale 2024",
"description": "Name of the campaign (required)."
},
"content": {
"type": "string",
"nullable": true,
"description": "HTML content for the campaign email."
},
"settings": {
"type": "object",
"example": {},
"nullable": true,
"description": "Additional campaign settings as a JSON object."
},
"from_name": {
"type": "string",
"nullable": true,
"description": "Display name for the sender."
},
"from_email": {
"type": "string",
"format": "email",
"nullable": true,
"description": "From email address. Domain must match a verified (ACTIVE) sending identity for the user."
},
"template_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "ID of the email template to use for this campaign (optional)."
},
"preview_text": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "Preview text shown in email clients (max 255 characters)."
},
"scheduled_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "ISO date string for when to schedule the campaign (must be a future date)."
},
"subject_line": {
"type": "string",
"nullable": true,
"maxLength": 998,
"description": "Subject line for the campaign email (max 998 characters)."
},
"target_groups": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true,
"description": "Array of group IDs to target with this campaign. All groups must belong to the user."
},
"reply_to_email": {
"type": "string",
"format": "email",
"nullable": true,
"description": "Reply-to email address."
}
}
}
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
curl --request POST 'https://email.1spoc.com/api/user/campaigns' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{}'
const response = await fetch('https://email.1spoc.com/api/user/campaigns', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://email.1spoc.com/api/user/campaigns', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests
url = 'https://email.1spoc.com/api/user/campaigns'
headers = {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
}
payload = json.loads(r'''{}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
String body = """
{}
""";
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/campaigns"))
.header("Authorization", "Bearer <TOKEN>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{}';
curl_setopt_array($curl, [
CURLOPT_URL => 'https://email.1spoc.com/api/user/campaigns',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>","Content-Type: application/json"],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var json = """
{}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://email.1spoc.com/api/user/campaigns", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"bytes"
)
func main() {
request, err := http.NewRequest("POST", "https://email.1spoc.com/api/user/campaigns", bytes.NewBufferString("{}"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Accept", "application/json")
request.Header.Set("Authorization", "Bearer <TOKEN>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{}
{
"$ref": "#/components/schemas/Campaign"
}
Status Codes
201Campaign created successfully.400Bad request - validation errors (missing required fields, invalid email format, invalid domain, etc.).401Unauthorized (missing or invalid user access token)404Template or target groups not found or don't belong to the user.409A campaign with this name already exists for this user.500Internal server error