Developer Hub
Developer Hub

Create Order

post
https://api.kayzen.io/v1/orders
Body Params
string

Advertiser ID (for enterprise admin user)

string
required

Order name

boolean
required
Defaults to true

Status
- true: Order is active
- false: Order is paused

int32

My App/Website ID. Required if your setup supports My App/Website feature
Use next API for creating My App/Website Objects:
- Create App Object
- Create Website Object

float

Daily budget capping. Applies to total spend across all campaigns under this Order, e.g., if one campaign reached the Order's daily budget then all other campaigns would be paused until the next day

float

Total budget capping. Applies to total spend across all campaigns under this Order, e.g., if one campaign reached the Order's total budget then all other campaigns would be paused

int32

Impression frequency capping: max this number of impressions per user per impression_cap_days
Applies to all campaigns under the Order, e.g., if one campaign reaches Order's daily impression cap, all campaigns under that Order will be paused for the day

int32

Impression frequency capping: max impression_cap_count of impressions per user per this number of days
Required if impression_cap_count is set
Send 999 for lifetime
Applies to all campaigns under the Order, e.g., if one campaign reaches Order's daily impression cap, all campaigns under that Order will be paused for the day

string
enum
required

Campaign objective that defines the goal of your order and campaigns created under it.

Allowed:
Responses

Updated 10 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago