Create Campaign

POST /campaigns
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/campaigns

Creates a new Campaign object

Request Body Schema
Arrow
Name
Description
account_idstringrequired
A unique account identifier generated by the Ocamba platform.


Example: 52794322
descriptionstring
Additional describtion of campaign, maximum 600 characters.


Example: Description goes here
end_timedateTime
A time when the campaign employment is over. At this point, campaign status will be automatically changed to 'paused' by backed processes. Timezone: GMT.


Example: 2021-10-29 13:07:04
exchange_idnumber
Exchange id created on the Ocamba platform. If exchange_id is set, the campaign type will be implicitly set to "external" otherwise, the campaign type will be "internal".


Example: 12341
frequency_capobject

Name
Description
impressionobject

Name
Description
expiry_timenumber
Time frame for frequency capping, expressed in hours.


Example: 10
max_countnumber
Max number of times a user sees ads for a given time frame.


Example: 2
iab_category[ string ]
An array of maximum 3 unique items, where every item must be a valid IAB category.


Example: IAB1-1,IAB1-2
namestringrequired
Name of the campaign, max 200 characters.


Example: DemoCampaign
pricing_modelstringrequired
Assigning the wanted pricing model to campaign.


Example: cpc

Possible values: cpc | cpm | cpa
remote_idnumber
Campaign id from an external source.


Example: 42131
scorenumber (integer)
Minimum value - 0, Maximum value - 100.


Example: 78

Default: 50
start_timedateTime
A time when the campaign will be employed. Only campaigns with active status will be employed once the start time is reached. If the start time is not specified, the campaign will start immediately. Timezone: GMT.


Example: 2021-10-20 12:47:00
statusstringrequired
The status reflects the current status of the campaign which may be overridden by its parent or by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
200 Arrow
  • 200
{
	"account_id": "1000000",
	"name": "My first campaign",
	"pricing_model": "cpm",
	"score": "60",
	"status": "active",
	"start_time": "2020-10-14 10:00"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
   "id":"1009154"
}