Create a campaign
curl --request POST \
--url https://app.clipstake.com/api/v1/agency/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"instructions": "Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.",
"content_type": "clipping",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
}
],
"max_payout_per_clip_cents": 50000,
"min_views": 1000,
"max_clips_per_creator": 10,
"eligibility": "open",
"end_date": "2026-12-31T00:00:00.000Z",
"thumbnail_url": "https://cdn.northwind.example/campaigns/autumn-roast.jpg",
"geo_targeting": [],
"agency_cpm_cents": 20,
"resources": []
}
'import requests
url = "https://app.clipstake.com/api/v1/agency/campaigns"
payload = {
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"instructions": "Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.",
"content_type": "clipping",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
}
],
"max_payout_per_clip_cents": 50000,
"min_views": 1000,
"max_clips_per_creator": 10,
"eligibility": "open",
"end_date": "2026-12-31T00:00:00.000Z",
"thumbnail_url": "https://cdn.northwind.example/campaigns/autumn-roast.jpg",
"geo_targeting": [],
"agency_cpm_cents": 20,
"resources": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: 'brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7',
name: 'Autumn Roast Launch',
instructions: 'Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.',
content_type: 'clipping',
budget_cents: 500000,
platforms: [{platform: 'instagram', cpm_cents: 200}],
max_payout_per_clip_cents: 50000,
min_views: 1000,
max_clips_per_creator: 10,
eligibility: 'open',
end_date: '2026-12-31T00:00:00.000Z',
thumbnail_url: 'https://cdn.northwind.example/campaigns/autumn-roast.jpg',
geo_targeting: [],
agency_cpm_cents: 20,
resources: []
})
};
fetch('https://app.clipstake.com/api/v1/agency/campaigns', 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://app.clipstake.com/api/v1/agency/campaigns",
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([
'brand_id' => 'brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7',
'name' => 'Autumn Roast Launch',
'instructions' => 'Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.',
'content_type' => 'clipping',
'budget_cents' => 500000,
'platforms' => [
[
'platform' => 'instagram',
'cpm_cents' => 200
]
],
'max_payout_per_clip_cents' => 50000,
'min_views' => 1000,
'max_clips_per_creator' => 10,
'eligibility' => 'open',
'end_date' => '2026-12-31T00:00:00.000Z',
'thumbnail_url' => 'https://cdn.northwind.example/campaigns/autumn-roast.jpg',
'geo_targeting' => [
],
'agency_cpm_cents' => 20,
'resources' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.clipstake.com/api/v1/agency/campaigns"
payload := strings.NewReader("{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.clipstake.com/api/v1/agency/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.clipstake.com/api/v1/agency/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60",
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"slug": "autumn-roast-launch",
"status": "pending_payment",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
},
{
"platform": "x",
"cpm_cents": 150
}
],
"geo_enabled": false,
"geo_targeting": [],
"max_payout_per_clip_cents": 50000,
"pause_threshold_percent": 80,
"start_date": "2026-10-31T09:12:00.000Z",
"end_date": "2026-11-30T09:12:00.000Z",
"launched_at": null,
"created_at": "2026-10-31T09:12:00.000Z",
"balance": {
"available_cents": 0,
"paid_gross_cents": 0
}
}{
"error": {
"code": "invalid_request",
"message": "Set a CPM for instagram. Without it those submissions would earn nothing.",
"request_id": "6f1c2a9e-4b7d-4c1a-9e2f-3a8b5c7d9e10"
}
}{
"error": {
"code": "unauthorized",
"message": "Provide a valid API key as `Authorization: Bearer ck_live_...`.",
"request_id": "0b7e4d2c-9a1f-4e3b-8c6d-5f2a1b9c7e34"
}
}{
"error": {
"code": "forbidden",
"message": "This API key cannot create campaigns. Create a key with write access in Settings, API keys.",
"request_id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c65"
}
}{
"error": {
"code": "not_found",
"message": "No such brand.",
"request_id": "3c9a8b7d-2e1f-4a6b-9c8d-7e6f5a4b3c21"
}
}{
"error": {
"code": "conflict",
"message": "A campaign with this name already exists for your brand.",
"request_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c19"
}
}{
"error": {
"code": "unavailable",
"message": "ClipStake is undergoing scheduled maintenance. Try again shortly.",
"request_id": "7c6b5a4f-3e2d-4c1b-9a8f-7e6d5c4b3a29"
}
}Campaigns
Create a campaign
Creates a campaign for one of your brands. The campaign starts as pending_payment. Fund it and launch it in the dashboard. The API key must have write access. The campaign runs the same checks as the dashboard. A name that the brand already uses returns 409, so a retry of a request that succeeded does not make a second campaign.
POST
/
campaigns
Create a campaign
curl --request POST \
--url https://app.clipstake.com/api/v1/agency/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"instructions": "Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.",
"content_type": "clipping",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
}
],
"max_payout_per_clip_cents": 50000,
"min_views": 1000,
"max_clips_per_creator": 10,
"eligibility": "open",
"end_date": "2026-12-31T00:00:00.000Z",
"thumbnail_url": "https://cdn.northwind.example/campaigns/autumn-roast.jpg",
"geo_targeting": [],
"agency_cpm_cents": 20,
"resources": []
}
'import requests
url = "https://app.clipstake.com/api/v1/agency/campaigns"
payload = {
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"instructions": "Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.",
"content_type": "clipping",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
}
],
"max_payout_per_clip_cents": 50000,
"min_views": 1000,
"max_clips_per_creator": 10,
"eligibility": "open",
"end_date": "2026-12-31T00:00:00.000Z",
"thumbnail_url": "https://cdn.northwind.example/campaigns/autumn-roast.jpg",
"geo_targeting": [],
"agency_cpm_cents": 20,
"resources": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: 'brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7',
name: 'Autumn Roast Launch',
instructions: 'Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.',
content_type: 'clipping',
budget_cents: 500000,
platforms: [{platform: 'instagram', cpm_cents: 200}],
max_payout_per_clip_cents: 50000,
min_views: 1000,
max_clips_per_creator: 10,
eligibility: 'open',
end_date: '2026-12-31T00:00:00.000Z',
thumbnail_url: 'https://cdn.northwind.example/campaigns/autumn-roast.jpg',
geo_targeting: [],
agency_cpm_cents: 20,
resources: []
})
};
fetch('https://app.clipstake.com/api/v1/agency/campaigns', 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://app.clipstake.com/api/v1/agency/campaigns",
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([
'brand_id' => 'brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7',
'name' => 'Autumn Roast Launch',
'instructions' => 'Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.',
'content_type' => 'clipping',
'budget_cents' => 500000,
'platforms' => [
[
'platform' => 'instagram',
'cpm_cents' => 200
]
],
'max_payout_per_clip_cents' => 50000,
'min_views' => 1000,
'max_clips_per_creator' => 10,
'eligibility' => 'open',
'end_date' => '2026-12-31T00:00:00.000Z',
'thumbnail_url' => 'https://cdn.northwind.example/campaigns/autumn-roast.jpg',
'geo_targeting' => [
],
'agency_cpm_cents' => 20,
'resources' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.clipstake.com/api/v1/agency/campaigns"
payload := strings.NewReader("{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.clipstake.com/api/v1/agency/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.clipstake.com/api/v1/agency/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7\",\n \"name\": \"Autumn Roast Launch\",\n \"instructions\": \"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind.\",\n \"content_type\": \"clipping\",\n \"budget_cents\": 500000,\n \"platforms\": [\n {\n \"platform\": \"instagram\",\n \"cpm_cents\": 200\n }\n ],\n \"max_payout_per_clip_cents\": 50000,\n \"min_views\": 1000,\n \"max_clips_per_creator\": 10,\n \"eligibility\": \"open\",\n \"end_date\": \"2026-12-31T00:00:00.000Z\",\n \"thumbnail_url\": \"https://cdn.northwind.example/campaigns/autumn-roast.jpg\",\n \"geo_targeting\": [],\n \"agency_cpm_cents\": 20,\n \"resources\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60",
"brand_id": "brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
"name": "Autumn Roast Launch",
"slug": "autumn-roast-launch",
"status": "pending_payment",
"budget_cents": 500000,
"platforms": [
{
"platform": "instagram",
"cpm_cents": 200
},
{
"platform": "x",
"cpm_cents": 150
}
],
"geo_enabled": false,
"geo_targeting": [],
"max_payout_per_clip_cents": 50000,
"pause_threshold_percent": 80,
"start_date": "2026-10-31T09:12:00.000Z",
"end_date": "2026-11-30T09:12:00.000Z",
"launched_at": null,
"created_at": "2026-10-31T09:12:00.000Z",
"balance": {
"available_cents": 0,
"paid_gross_cents": 0
}
}{
"error": {
"code": "invalid_request",
"message": "Set a CPM for instagram. Without it those submissions would earn nothing.",
"request_id": "6f1c2a9e-4b7d-4c1a-9e2f-3a8b5c7d9e10"
}
}{
"error": {
"code": "unauthorized",
"message": "Provide a valid API key as `Authorization: Bearer ck_live_...`.",
"request_id": "0b7e4d2c-9a1f-4e3b-8c6d-5f2a1b9c7e34"
}
}{
"error": {
"code": "forbidden",
"message": "This API key cannot create campaigns. Create a key with write access in Settings, API keys.",
"request_id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c65"
}
}{
"error": {
"code": "not_found",
"message": "No such brand.",
"request_id": "3c9a8b7d-2e1f-4a6b-9c8d-7e6f5a4b3c21"
}
}{
"error": {
"code": "conflict",
"message": "A campaign with this name already exists for your brand.",
"request_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c19"
}
}{
"error": {
"code": "unavailable",
"message": "ClipStake is undergoing scheduled maintenance. Try again shortly.",
"request_id": "7c6b5a4f-3e2d-4c1b-9a8f-7e6d5c4b3a29"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The campaign to create.
The brand that owns the campaign. A brand ID that your API key cannot read returns 404.
Example:
"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7"
The campaign name. It must be different from the names of the brand's other campaigns.
Required string length:
1 - 256Example:
"Autumn Roast Launch"
What creators must do in their clips. Creators see this text.
Minimum string length:
1Example:
"Post a 15 to 45 second clip that shows the new autumn roast. Tag @northwind."
The kind of clip: clipping, logo, music, ugc or reposting.
Available options:
logo, clipping, music, ugc, reposting Example:
"clipping"
The budget for clips, in cents. It does not include the ClipStake fee, which you pay when you fund the campaign.
Required range:
100 <= x <= 9007199254740991Example:
500000
The platforms the campaign accepts clips from, each with its rate.
Required array length:
1 - 2 elementsShow child attributes
Show child attributes
The most that one clip can earn from the campaign, in cents.
Required range:
x <= 9007199254740991Example:
50000
The views a clip must get before it can earn.
Required range:
x <= 9007199254740991Example:
1000
The most clips one creator can submit to the campaign. Leave it out for no limit.
Required range:
x <= 9007199254740991Example:
10
open: every creator can find the campaign and submit. private: only creators that you invite in the dashboard can submit. The default is open.
Available options:
open, private Example:
"open"
When the campaign ends. Omit it for a campaign with no end date.
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))$Example:
"2026-12-31T00:00:00.000Z"
The campaign image that creators see. Use an https link to a JPEG, PNG or WebP image.
Example:
"https://cdn.northwind.example/campaigns/autumn-roast.jpg"
Pay by the country of the viewers. Send include rules or one exclude rule, never both. Needs instagram in platforms, and cannot be used with x. Leave it out or send an empty list to pay the platform rates for every view.
Show child attributes
Show child attributes
Example:
[]
Your agency's share of each 1,000 views, in cents. Creators earn every rate less this amount, and the difference goes to your wallet when payouts are released. It must be less than every rate in the campaign. Leave it out to keep no share.
Required range:
x <= 9007199254740991Example:
20
Files and folders for creators.
Maximum array length:
20Show child attributes
Show child attributes
Response
Successful response
A campaign that your agency can read.
Campaign ID.
Pattern:
^cmp_[0-9a-f]{32}$Example:
"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60"
Brand ID.
Pattern:
^brd_[0-9a-f]{32}$Example:
"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7"
The campaign name.
Example:
"Autumn Roast Launch"
The short name of the campaign in ClipStake web addresses.
Example:
"autumn-roast-launch"
pending_payment: the budget is not paid yet. ready_to_launch: the budget is paid and the campaign is not live yet. active: the campaign is live and clips earn. paused: the campaign stopped paying for new views. ended: the campaign is over.
Available options:
pending_payment, ready_to_launch, active, paused, ended Example:
"active"
The campaign budget for clips, in cents. It does not include the ClipStake fee.
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
500000
The platforms that the campaign accepts clips from, each with its rate.
Show child attributes
Show child attributes
True when the campaign pays by the country of the viewers.
Example:
false
The country rules of the campaign, include rules first, in the order the campaign shows them. A campaign has include rules or one exclude rule, never both. With include rules, views from other countries earn nothing. Empty when geo targeting is off.
Show child attributes
Show child attributes
Example:
[]
The most that one clip can earn from the campaign, in cents.
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
50000
The campaign pauses when its clips have earned this percentage of the budget.
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
90
When the campaign starts.
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))$Example:
"2026-09-15T00:00:00.000Z"
When the campaign ends. Null if the campaign has no end date.
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))$Example:
"2026-10-15T00:00:00.000Z"
When the campaign went live. Null if it never went live.
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))$Example:
"2026-09-15T09:00:00.000Z"
When the campaign was created.
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))$Example:
"2026-09-10T14:20:00.000Z"
The money in the campaign.
Show child attributes
Show child attributes