Skip to main content
POST
/
cabinet
/
admin
/
campaigns
Create New Campaign
curl --request POST \
  --url https://api.example.com/cabinet/admin/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "start_parameter": "<string>",
  "is_active": true,
  "balance_bonus_kopeks": 0,
  "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
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bedolagam.ru/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to create a campaign.

​
name
string
required
Required string length: 1 - 255
​
start_parameter
string
required
Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
​
bonus_type
enum<string>
required
Available options:
balance,
subscription,
none,
tariff
​
is_active
boolean
default:true
​
balance_bonus_kopeks
integer
default:0
Required range: x >= 0
​
subscription_duration_days
integer | null
Required range: x >= 1
​
subscription_traffic_gb
integer | null
Required range: x >= 0
​
subscription_device_limit
integer | null
Required range: x >= 1
​
subscription_squads
string[]
​
tariff_id
integer | null
​
tariff_duration_days
integer | null
Required range: x >= 1
​
partner_user_id
integer | null

Response

Successful Response

Detailed campaign response.

​
id
integer
required
​
name
string
required
​
start_parameter
string
required
​
bonus_type
enum<string>
required
Available options:
balance,
subscription,
none,
tariff
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
balance_bonus_kopeks
integer
default:0
​
balance_bonus_rubles
number
default:0
​
subscription_duration_days
integer | null
​
subscription_traffic_gb
integer | null
​
subscription_device_limit
integer | null
​
subscription_squads
string[]
​
tariff_id
integer | null
​
tariff_duration_days
integer | null
​
tariff
TariffInfo · object

Tariff info for campaign.

​
partner_user_id
integer | null
​
partner_name
string | null
​
created_by
integer | null
​
updated_at
string<date-time> | null
​
deep_link
string | null
​
web_link
string | null