Create a campaign
curl --request POST \
--url https://api.spacebring.com/campaigns/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"name": "<string>",
"email": {
"body": "",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "jsmith@example.com",
"subject": ""
},
"push": {
"body": "",
"link": "<string>",
"title": ""
}
}
}
'import requests
url = "https://api.spacebring.com/campaigns/v1"
payload = { "campaign": {
"audience": {
"locationRefs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"rules": [
{
"companyRefs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"type": "companies"
}
]
},
"name": "<string>",
"email": {
"body": "",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "jsmith@example.com",
"subject": ""
},
"push": {
"body": "",
"link": "<string>",
"title": ""
}
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign: {
audience: {
locationRefs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
rules: [{companyRefs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], type: 'companies'}]
},
name: '<string>',
email: {
body: JSON.stringify(''),
buttonLabel: '<string>',
buttonUrl: '<string>',
replyTo: 'jsmith@example.com',
subject: ''
},
push: {body: JSON.stringify(''), link: '<string>', title: ''}
}
})
};
fetch('https://api.spacebring.com/campaigns/v1', 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.spacebring.com/campaigns/v1",
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([
'campaign' => [
'audience' => [
'locationRefs' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'rules' => [
[
'companyRefs' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'type' => 'companies'
]
]
],
'name' => '<string>',
'email' => [
'body' => '',
'buttonLabel' => '<string>',
'buttonUrl' => '<string>',
'replyTo' => 'jsmith@example.com',
'subject' => ''
],
'push' => [
'body' => '',
'link' => '<string>',
'title' => ''
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.spacebring.com/campaigns/v1"
payload := strings.NewReader("{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.spacebring.com/campaigns/v1")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"channel": "email",
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stats": {
"bounced": 0,
"clicked": 0,
"complained": 0,
"delivered": 0,
"opened": 0,
"recipients": 0
},
"status": "draft",
"updateDate": "2023-11-07T05:31:56Z",
"charge": {
"amount": 0,
"currencyCode": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"email": {
"body": "<string>",
"subject": "<string>",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "<string>"
},
"push": {
"body": "<string>",
"title": "<string>",
"link": "<string>"
},
"scheduleDate": "2023-11-07T05:31:56Z",
"sendDate": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Campaigns
Create a campaign
Create a campaign as a draft, which an administrator sends from the admin web portal: the API cannot send, test, or schedule a campaign. A draft can be saved before its content is complete. A campaign created with basic authentication has no createdBy. With bearer token authentication, the user must be an administrator who can manage campaigns in every location of the audience.
OAuth
Required scopes:campaignsPOST
/
campaigns
/
v1
Create a campaign
curl --request POST \
--url https://api.spacebring.com/campaigns/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"name": "<string>",
"email": {
"body": "",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "jsmith@example.com",
"subject": ""
},
"push": {
"body": "",
"link": "<string>",
"title": ""
}
}
}
'import requests
url = "https://api.spacebring.com/campaigns/v1"
payload = { "campaign": {
"audience": {
"locationRefs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"rules": [
{
"companyRefs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"type": "companies"
}
]
},
"name": "<string>",
"email": {
"body": "",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "jsmith@example.com",
"subject": ""
},
"push": {
"body": "",
"link": "<string>",
"title": ""
}
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign: {
audience: {
locationRefs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
rules: [{companyRefs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], type: 'companies'}]
},
name: '<string>',
email: {
body: JSON.stringify(''),
buttonLabel: '<string>',
buttonUrl: '<string>',
replyTo: 'jsmith@example.com',
subject: ''
},
push: {body: JSON.stringify(''), link: '<string>', title: ''}
}
})
};
fetch('https://api.spacebring.com/campaigns/v1', 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.spacebring.com/campaigns/v1",
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([
'campaign' => [
'audience' => [
'locationRefs' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'rules' => [
[
'companyRefs' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'type' => 'companies'
]
]
],
'name' => '<string>',
'email' => [
'body' => '',
'buttonLabel' => '<string>',
'buttonUrl' => '<string>',
'replyTo' => 'jsmith@example.com',
'subject' => ''
],
'push' => [
'body' => '',
'link' => '<string>',
'title' => ''
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.spacebring.com/campaigns/v1"
payload := strings.NewReader("{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.spacebring.com/campaigns/v1")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/campaigns/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign\": {\n \"audience\": {\n \"locationRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"rules\": [\n {\n \"companyRefs\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type\": \"companies\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"email\": {\n \"body\": \"\",\n \"buttonLabel\": \"<string>\",\n \"buttonUrl\": \"<string>\",\n \"replyTo\": \"jsmith@example.com\",\n \"subject\": \"\"\n },\n \"push\": {\n \"body\": \"\",\n \"link\": \"<string>\",\n \"title\": \"\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"audience": {
"locationRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rules": [
{
"companyRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"type": "companies"
}
]
},
"channel": "email",
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"stats": {
"bounced": 0,
"clicked": 0,
"complained": 0,
"delivered": 0,
"opened": 0,
"recipients": 0
},
"status": "draft",
"updateDate": "2023-11-07T05:31:56Z",
"charge": {
"amount": 0,
"currencyCode": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"email": {
"body": "<string>",
"subject": "<string>",
"buttonLabel": "<string>",
"buttonUrl": "<string>",
"replyTo": "<string>"
},
"push": {
"body": "<string>",
"title": "<string>",
"link": "<string>"
},
"scheduleDate": "2023-11-07T05:31:56Z",
"sendDate": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Authorizations
BasicAuthOAuth2
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Body
application/json
The campaign to create as a draft.
Show child attributes
Show child attributes
Response
Created
The campaign.
Show child attributes
Show child attributes