cURL
curl --request PUT \
--url https://app.masivo.ai/api/storefront/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "<string>",
"platforms": [
{
"label": "<string>",
"value": "<string>"
}
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"rules": "[{\"conditions\":[],\"effects\":[{\"reward_id\":\"1334205e-4876-4f04-9d4b-e58b3778be44\",\"type\":\"DISCOUNT\",\"tier_id\":null,\"expiration_date\":null,\"amount\":10}]}]",
"attributes": {
"trigger": "PURCHASE"
},
"start_date": "2023-11-07T05:31:56Z",
"withoutEndDate": true,
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000,
"labels": [
{
"label": "<string>",
"value": "<string>"
}
],
"metadata": "<string>",
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "Name of the image",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"useCustomCodes": true,
"customCodes": "<string>",
"confirm_changes": true,
"referee_rules_json": "<string>"
}
'import requests
url = "https://app.masivo.ai/api/storefront/v1/campaigns/{id}"
payload = {
"brand_id": "<string>",
"platforms": [
{
"label": "<string>",
"value": "<string>"
}
],
"stores": ["<string>"],
"channels": ["<string>"],
"products": ["<string>"],
"tiers": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"name": "<string>",
"description": "<string>",
"rules": "[{\"conditions\":[],\"effects\":[{\"reward_id\":\"1334205e-4876-4f04-9d4b-e58b3778be44\",\"type\":\"DISCOUNT\",\"tier_id\":null,\"expiration_date\":null,\"amount\":10}]}]",
"attributes": { "trigger": "PURCHASE" },
"start_date": "2023-11-07T05:31:56Z",
"withoutEndDate": True,
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000,
"labels": [
{
"label": "<string>",
"value": "<string>"
}
],
"metadata": "<string>",
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "Name of the image",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"useCustomCodes": True,
"customCodes": "<string>",
"confirm_changes": True,
"referee_rules_json": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: '<string>',
platforms: [{label: '<string>', value: '<string>'}],
stores: ['<string>'],
channels: ['<string>'],
products: ['<string>'],
tiers: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
name: '<string>',
description: '<string>',
rules: '[{"conditions":[],"effects":[{"reward_id":"1334205e-4876-4f04-9d4b-e58b3778be44","type":"DISCOUNT","tier_id":null,"expiration_date":null,"amount":10}]}]',
attributes: {trigger: 'PURCHASE'},
start_date: '2023-11-07T05:31:56Z',
withoutEndDate: true,
end_date: '2023-11-07T05:31:56Z',
funded_by: '<string>',
budget: 1000,
labels: [{label: '<string>', value: '<string>'}],
metadata: '<string>',
content: {
Title: {name: 'Title', type: 'input', value: 'Value of the title'},
BannerImage: {
alt: 'Alternative description for the image',
href: 'Href link for the image',
name: 'Name of the image',
type: 'image',
value: 'https://URL_TO_IMAGE'
},
Description: {
name: 'Name of the description',
type: 'input',
value: 'Value of the description'
}
},
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
useCustomCodes: true,
customCodes: '<string>',
confirm_changes: true,
referee_rules_json: '<string>'
})
};
fetch('https://app.masivo.ai/api/storefront/v1/campaigns/{id}', 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.masivo.ai/api/storefront/v1/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'brand_id' => '<string>',
'platforms' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'stores' => [
'<string>'
],
'channels' => [
'<string>'
],
'products' => [
'<string>'
],
'tiers' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'name' => '<string>',
'description' => '<string>',
'rules' => '[{"conditions":[],"effects":[{"reward_id":"1334205e-4876-4f04-9d4b-e58b3778be44","type":"DISCOUNT","tier_id":null,"expiration_date":null,"amount":10}]}]',
'attributes' => [
'trigger' => 'PURCHASE'
],
'start_date' => '2023-11-07T05:31:56Z',
'withoutEndDate' => true,
'end_date' => '2023-11-07T05:31:56Z',
'funded_by' => '<string>',
'budget' => 1000,
'labels' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'metadata' => '<string>',
'content' => [
'Title' => [
'name' => 'Title',
'type' => 'input',
'value' => 'Value of the title'
],
'BannerImage' => [
'alt' => 'Alternative description for the image',
'href' => 'Href link for the image',
'name' => 'Name of the image',
'type' => 'image',
'value' => 'https://URL_TO_IMAGE'
],
'Description' => [
'name' => 'Name of the description',
'type' => 'input',
'value' => 'Value of the description'
]
],
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'useCustomCodes' => true,
'customCodes' => '<string>',
'confirm_changes' => true,
'referee_rules_json' => '<string>'
]),
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.masivo.ai/api/storefront/v1/campaigns/{id}"
payload := strings.NewReader("{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.masivo.ai/api/storefront/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.masivo.ai/api/storefront/v1/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "RUNNING",
"attributes": {},
"brand_id": "<string>",
"type": "BEHAVIOR",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 123,
"divide_budget_in": "daily",
"description": "<string>",
"metadata": {},
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"team_ids": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"team_ids": [
"<string>"
],
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "BannerImage",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Campaigns
Update campaign
Update a campaign with a full payload. Requires a SERVER API token. The account_id is derived from the access token and must not be sent in the request body. The type query parameter must match the existing campaign type. Updates reject missing campaigns, invalid payloads, and blocked sensitive changes. Ended campaigns cannot be updated. Started campaigns cannot update start_date, attributes, rules, or brand_id, and end_date cannot be moved to the past.
PUT
/
campaigns
/
{id}
cURL
curl --request PUT \
--url https://app.masivo.ai/api/storefront/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "<string>",
"platforms": [
{
"label": "<string>",
"value": "<string>"
}
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"rules": "[{\"conditions\":[],\"effects\":[{\"reward_id\":\"1334205e-4876-4f04-9d4b-e58b3778be44\",\"type\":\"DISCOUNT\",\"tier_id\":null,\"expiration_date\":null,\"amount\":10}]}]",
"attributes": {
"trigger": "PURCHASE"
},
"start_date": "2023-11-07T05:31:56Z",
"withoutEndDate": true,
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000,
"labels": [
{
"label": "<string>",
"value": "<string>"
}
],
"metadata": "<string>",
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "Name of the image",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"useCustomCodes": true,
"customCodes": "<string>",
"confirm_changes": true,
"referee_rules_json": "<string>"
}
'import requests
url = "https://app.masivo.ai/api/storefront/v1/campaigns/{id}"
payload = {
"brand_id": "<string>",
"platforms": [
{
"label": "<string>",
"value": "<string>"
}
],
"stores": ["<string>"],
"channels": ["<string>"],
"products": ["<string>"],
"tiers": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"name": "<string>",
"description": "<string>",
"rules": "[{\"conditions\":[],\"effects\":[{\"reward_id\":\"1334205e-4876-4f04-9d4b-e58b3778be44\",\"type\":\"DISCOUNT\",\"tier_id\":null,\"expiration_date\":null,\"amount\":10}]}]",
"attributes": { "trigger": "PURCHASE" },
"start_date": "2023-11-07T05:31:56Z",
"withoutEndDate": True,
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000,
"labels": [
{
"label": "<string>",
"value": "<string>"
}
],
"metadata": "<string>",
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "Name of the image",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"useCustomCodes": True,
"customCodes": "<string>",
"confirm_changes": True,
"referee_rules_json": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: '<string>',
platforms: [{label: '<string>', value: '<string>'}],
stores: ['<string>'],
channels: ['<string>'],
products: ['<string>'],
tiers: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
name: '<string>',
description: '<string>',
rules: '[{"conditions":[],"effects":[{"reward_id":"1334205e-4876-4f04-9d4b-e58b3778be44","type":"DISCOUNT","tier_id":null,"expiration_date":null,"amount":10}]}]',
attributes: {trigger: 'PURCHASE'},
start_date: '2023-11-07T05:31:56Z',
withoutEndDate: true,
end_date: '2023-11-07T05:31:56Z',
funded_by: '<string>',
budget: 1000,
labels: [{label: '<string>', value: '<string>'}],
metadata: '<string>',
content: {
Title: {name: 'Title', type: 'input', value: 'Value of the title'},
BannerImage: {
alt: 'Alternative description for the image',
href: 'Href link for the image',
name: 'Name of the image',
type: 'image',
value: 'https://URL_TO_IMAGE'
},
Description: {
name: 'Name of the description',
type: 'input',
value: 'Value of the description'
}
},
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
useCustomCodes: true,
customCodes: '<string>',
confirm_changes: true,
referee_rules_json: '<string>'
})
};
fetch('https://app.masivo.ai/api/storefront/v1/campaigns/{id}', 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.masivo.ai/api/storefront/v1/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'brand_id' => '<string>',
'platforms' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'stores' => [
'<string>'
],
'channels' => [
'<string>'
],
'products' => [
'<string>'
],
'tiers' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'name' => '<string>',
'description' => '<string>',
'rules' => '[{"conditions":[],"effects":[{"reward_id":"1334205e-4876-4f04-9d4b-e58b3778be44","type":"DISCOUNT","tier_id":null,"expiration_date":null,"amount":10}]}]',
'attributes' => [
'trigger' => 'PURCHASE'
],
'start_date' => '2023-11-07T05:31:56Z',
'withoutEndDate' => true,
'end_date' => '2023-11-07T05:31:56Z',
'funded_by' => '<string>',
'budget' => 1000,
'labels' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'metadata' => '<string>',
'content' => [
'Title' => [
'name' => 'Title',
'type' => 'input',
'value' => 'Value of the title'
],
'BannerImage' => [
'alt' => 'Alternative description for the image',
'href' => 'Href link for the image',
'name' => 'Name of the image',
'type' => 'image',
'value' => 'https://URL_TO_IMAGE'
],
'Description' => [
'name' => 'Name of the description',
'type' => 'input',
'value' => 'Value of the description'
]
],
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'useCustomCodes' => true,
'customCodes' => '<string>',
'confirm_changes' => true,
'referee_rules_json' => '<string>'
]),
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.masivo.ai/api/storefront/v1/campaigns/{id}"
payload := strings.NewReader("{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.masivo.ai/api/storefront/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.masivo.ai/api/storefront/v1/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"<string>\",\n \"platforms\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"stores\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"products\": [\n \"<string>\"\n ],\n \"tiers\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": \"[{\\\"conditions\\\":[],\\\"effects\\\":[{\\\"reward_id\\\":\\\"1334205e-4876-4f04-9d4b-e58b3778be44\\\",\\\"type\\\":\\\"DISCOUNT\\\",\\\"tier_id\\\":null,\\\"expiration_date\\\":null,\\\"amount\\\":10}]}]\",\n \"attributes\": {\n \"trigger\": \"PURCHASE\"\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"withoutEndDate\": true,\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"funded_by\": \"<string>\",\n \"budget\": 1000,\n \"labels\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metadata\": \"<string>\",\n \"content\": {\n \"Title\": {\n \"name\": \"Title\",\n \"type\": \"input\",\n \"value\": \"Value of the title\"\n },\n \"BannerImage\": {\n \"alt\": \"Alternative description for the image\",\n \"href\": \"Href link for the image\",\n \"name\": \"Name of the image\",\n \"type\": \"image\",\n \"value\": \"https://URL_TO_IMAGE\"\n },\n \"Description\": {\n \"name\": \"Name of the description\",\n \"type\": \"input\",\n \"value\": \"Value of the description\"\n }\n },\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"useCustomCodes\": true,\n \"customCodes\": \"<string>\",\n \"confirm_changes\": true,\n \"referee_rules_json\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "RUNNING",
"attributes": {},
"brand_id": "<string>",
"type": "BEHAVIOR",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 123,
"divide_budget_in": "daily",
"description": "<string>",
"metadata": {},
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"team_ids": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"team_ids": [
"<string>"
],
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"content": {
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "BannerImage",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The campaign unique identifier
Query Parameters
The campaign type
Available options:
BEHAVIOR, COUPONS, PUNCH_CARDS, REFERRALS, SCORE_STREAKS Body
application/json
Storefront campaign write payload. Send the campaign type as the required type query parameter, not in the body. The body mirrors the dashboard campaign form for that type. account_id is derived from the SERVER token. Common validation: rules must contain at least one main/referrer rule, metadata must be a JSON object encoded as a string, budget must be at least 1, labels and platforms use dashboard select values, content stores optional CMS template field values, and dates must follow the campaign date restrictions.
The brand id of the campaign, null if is a global campaign
Platform select values where this campaign applies
Show child attributes
Show child attributes
Store ids this campaign is restricted to. null means no store restriction; a non-empty array restricts the campaign to those stores; [] is an explicit empty restriction and matches no stores.
Channel ids this campaign is restricted to. null means no channel restriction; a non-empty array restricts the campaign to those channels; [] is an explicit empty restriction and matches no channels.
Product ids this campaign is restricted to. null means no product restriction; a non-empty array restricts the campaign to those products; [] is an explicit empty restriction and matches no products.
Tier ids allowed to earn from this campaign. null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.
The name of the campaign
The description of the campaign
JSON string of an array of Rule objects (see the Rule/Effect schemas) with the main/referrer campaign rules. Must contain at least one rule for every campaign type, including REFERRALS. referee_rules_json does not replace this field. Each rule's effects[].reward_id must be the id of a reward that already exists and is ACTIVE for the account; create the reward from the dashboard first, this endpoint does not create rewards.
Example:
"[{\"conditions\":[],\"effects\":[{\"reward_id\":\"1334205e-4876-4f04-9d4b-e58b3778be44\",\"type\":\"DISCOUNT\",\"tier_id\":null,\"expiration_date\":null,\"amount\":10}]}]"
The attributes of the campaign
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
The persisted campaign status for create/update requests
Available options:
ACTIVE, INACTIVE The start date of the campaign. On create, and on updates for scheduled campaigns, it must be today or later and less than one year from now.
When true, end_date must be omitted and the campaign is stored without an end date.
The end date of the campaign. Omit it when withoutEndDate is true. When provided, it must be after start_date and less than one year from start_date.
Who is funding these campaign
The budget of the campaign
Example:
1000
Available options:
daily, weekly, monthly, total Label select values
Show child attributes
Show child attributes
JSON object encoded as a string
Optional CMS content values for the campaign. Each key is a template field name and each value contains the field metadata, type, and value. Send an empty object when the campaign has no CMS content.
Example:
{
"Title": {
"name": "Title",
"type": "input",
"value": "Value of the title"
},
"BannerImage": {
"alt": "Alternative description for the image",
"href": "Href link for the image",
"name": "Name of the image",
"type": "image",
"value": "https://URL_TO_IMAGE"
},
"Description": {
"name": "Name of the description",
"type": "input",
"value": "Value of the description"
}
}
Optional CMS template id used to structure the campaign content. Send null when no template is selected.
COUPONS only. Number of coupon codes to generate or keep. Must be positive and within the safe limit for generated codes.
COUPONS only. When true, customCodes is used instead of generated codes
COUPONS only. Comma-separated custom coupon codes. Required to contain at least one non-empty code when useCustomCodes is true.
COUPONS update only. Required as true when changing code format or quantity
REFERRALS only. JSON string with referee campaign rules. This is optional and does not replace the required main/referrer rules field.
Response
Campaign updated
Campaign response. account_id, order, and created_at are not returned.
Show child attributes
Show child attributes