Update Existing Campaign
curl --request PUT \
--url https://api.example.com/cabinet/admin/campaigns/{campaign_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"start_parameter": "<string>",
"is_active": true,
"balance_bonus_kopeks": 1,
"subscription_duration_days": 2,
"subscription_traffic_gb": 1,
"subscription_device_limit": 2,
"subscription_squads": [
"<string>"
],
"tariff_id": 123,
"tariff_duration_days": 2,
"partner_user_id": 123
}
'import requests
url = "https://api.example.com/cabinet/admin/campaigns/{campaign_id}"
payload = {
"name": "<string>",
"start_parameter": "<string>",
"is_active": True,
"balance_bonus_kopeks": 1,
"subscription_duration_days": 2,
"subscription_traffic_gb": 1,
"subscription_device_limit": 2,
"subscription_squads": ["<string>"],
"tariff_id": 123,
"tariff_duration_days": 2,
"partner_user_id": 123
}
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({
name: '<string>',
start_parameter: '<string>',
is_active: true,
balance_bonus_kopeks: 1,
subscription_duration_days: 2,
subscription_traffic_gb: 1,
subscription_device_limit: 2,
subscription_squads: ['<string>'],
tariff_id: 123,
tariff_duration_days: 2,
partner_user_id: 123
})
};
fetch('https://api.example.com/cabinet/admin/campaigns/{campaign_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://api.example.com/cabinet/admin/campaigns/{campaign_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([
'name' => '<string>',
'start_parameter' => '<string>',
'is_active' => true,
'balance_bonus_kopeks' => 1,
'subscription_duration_days' => 2,
'subscription_traffic_gb' => 1,
'subscription_device_limit' => 2,
'subscription_squads' => [
'<string>'
],
'tariff_id' => 123,
'tariff_duration_days' => 2,
'partner_user_id' => 123
]),
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://api.example.com/cabinet/admin/campaigns/{campaign_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\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://api.example.com/cabinet/admin/campaigns/{campaign_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cabinet/admin/campaigns/{campaign_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 \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"start_parameter": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"balance_bonus_kopeks": 0,
"balance_bonus_rubles": 0,
"subscription_duration_days": 123,
"subscription_traffic_gb": 123,
"subscription_device_limit": 123,
"subscription_squads": [
"<string>"
],
"tariff_id": 123,
"tariff_duration_days": 123,
"tariff": {
"id": 123,
"name": "<string>"
},
"partner_user_id": 123,
"partner_name": "<string>",
"created_by": 123,
"updated_at": "2023-11-07T05:31:56Z",
"deep_link": "<string>",
"web_link": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Cabinet Admin Campaigns
Update Existing Campaign
Update an existing campaign.
PUT
/
cabinet
/
admin
/
campaigns
/
{campaign_id}
Update Existing Campaign
curl --request PUT \
--url https://api.example.com/cabinet/admin/campaigns/{campaign_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"start_parameter": "<string>",
"is_active": true,
"balance_bonus_kopeks": 1,
"subscription_duration_days": 2,
"subscription_traffic_gb": 1,
"subscription_device_limit": 2,
"subscription_squads": [
"<string>"
],
"tariff_id": 123,
"tariff_duration_days": 2,
"partner_user_id": 123
}
'import requests
url = "https://api.example.com/cabinet/admin/campaigns/{campaign_id}"
payload = {
"name": "<string>",
"start_parameter": "<string>",
"is_active": True,
"balance_bonus_kopeks": 1,
"subscription_duration_days": 2,
"subscription_traffic_gb": 1,
"subscription_device_limit": 2,
"subscription_squads": ["<string>"],
"tariff_id": 123,
"tariff_duration_days": 2,
"partner_user_id": 123
}
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({
name: '<string>',
start_parameter: '<string>',
is_active: true,
balance_bonus_kopeks: 1,
subscription_duration_days: 2,
subscription_traffic_gb: 1,
subscription_device_limit: 2,
subscription_squads: ['<string>'],
tariff_id: 123,
tariff_duration_days: 2,
partner_user_id: 123
})
};
fetch('https://api.example.com/cabinet/admin/campaigns/{campaign_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://api.example.com/cabinet/admin/campaigns/{campaign_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([
'name' => '<string>',
'start_parameter' => '<string>',
'is_active' => true,
'balance_bonus_kopeks' => 1,
'subscription_duration_days' => 2,
'subscription_traffic_gb' => 1,
'subscription_device_limit' => 2,
'subscription_squads' => [
'<string>'
],
'tariff_id' => 123,
'tariff_duration_days' => 2,
'partner_user_id' => 123
]),
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://api.example.com/cabinet/admin/campaigns/{campaign_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\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://api.example.com/cabinet/admin/campaigns/{campaign_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cabinet/admin/campaigns/{campaign_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 \"name\": \"<string>\",\n \"start_parameter\": \"<string>\",\n \"is_active\": true,\n \"balance_bonus_kopeks\": 1,\n \"subscription_duration_days\": 2,\n \"subscription_traffic_gb\": 1,\n \"subscription_device_limit\": 2,\n \"subscription_squads\": [\n \"<string>\"\n ],\n \"tariff_id\": 123,\n \"tariff_duration_days\": 2,\n \"partner_user_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"start_parameter": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"balance_bonus_kopeks": 0,
"balance_bonus_rubles": 0,
"subscription_duration_days": 123,
"subscription_traffic_gb": 123,
"subscription_device_limit": 123,
"subscription_squads": [
"<string>"
],
"tariff_id": 123,
"tariff_duration_days": 123,
"tariff": {
"id": 123,
"name": "<string>"
},
"partner_user_id": 123,
"partner_name": "<string>",
"created_by": 123,
"updated_at": "2023-11-07T05:31:56Z",
"deep_link": "<string>",
"web_link": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Request to update a campaign.
Required string length:
1 - 255Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$Available options:
balance, subscription, none, tariff Required range:
x >= 0Required range:
x >= 1Required range:
x >= 0Required range:
x >= 1Required range:
x >= 1Response
Successful Response
Detailed campaign response.
Available options:
balance, subscription, none, tariff Tariff info for campaign.
Show child attributes
Show child attributes
⌘I
