Update Budget

PS: You need to use Token to change the status, for more details, please check Token

Through this api, you can change the budget for offers.

1 You can add a budget for all the area which offer is promoting in or add different budget for different area.
2 If you’d like to add a budget for all the targeting region in offer，just leave country_code as "ALL".
3 If you need to add budget for different region in an offer, please add country code of area in field "country_code", besides, if you add more than one region code in the same "country_code", that means this group of area will share the budget.
Notes:
A) you can only add budget for area you are targeting in offer.
B) If you choose to maintain budget by area, please be sure you’ve set budget for all the area that offer is targeting, and it is forbidden to add different budget for same area in an offer.

Request address

https://ss-api.mintegral.com/api/open/v1/offer/budget

Request method

PUT

Request example

PUT /api/open/v1/offer/budget
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
  "offer_id": 123,
  "budget": [
    {
      "country_code": "US",
      "daily_cap_type": "BUDGET",
      "daily_cap": 0,
      "total_budget": "OPEN"
    },
    {
      "country_code": "CN",
      "daily_cap_type": "BUDGET",
      "daily_cap": 0,
      "total_budget": "OPEN"
    }
  ]
}

Request Parameter

Fields	Type	Explanations	Default Value	Examples
offer_id	int	Unique id for offer	—	123
budget	array	Budget for offer	—	—
country_code	string	Region you’ve add budget specifically	—	"CN,EN"
daily_cap_type	string	Type of daily budget，you can choose "BUDGET" to manage budget via the spending of offer, otherwise , you can choose "CONVERSION" to control budget via the amount of conversion	—	"BUDGET"
daily_cap	int	Minimum is 50	—	—
total_budget	string / int	Add offer budget for a period of time."OPEN" means no budget.	—	"OPEN"
total_budget_effective_time Deprecated	string	Effective time for total budget, for example, YYYY-MM-DD	—	"2019-05-09"
total_budget_effective_timezone Deprecated	number	Timezone for effective time of total budget, please check：[ENUM - Timezone] to get details	—	5.5

Response

Fields	Type	Explanations
code	int	200 code, is success. Others, are fail.
msg	string	If success, return to "success". If fail, return to detailed wrong info.
data	json	If success, return plain object. If fail, return to detailed wrong info.

Response Example

{
  "msg": "success",
  "code": 200,
  "data": {}
}

Error Code

For example,

{
  "code": 10000,
  "msg": "error",
  "data": {
    "budget": "The budget field is required."
  }
}

Please check below to get the details of error code:

code	msg	data	Explanations
10000	error	{ "budget": "The budget field is required." }	Budget Fields can’t be null
10000	error	{ "budget": "budget is not json string!" }	Budget Fields should be Json
11423	budget is error!	{ "country_code": "you can only set ALL budget or special budget!" }	1 If you’d like to add a budget for all the targeting region in offer，just leave country_code as "ALL" 2 If you need to add budget for different region in an offer, please add country code of area in field “country_code”, besides, if you add more than one region code in the same “country_code”, that means this group of area will share the budget. 3 It is forbidden to set country_code for budget as “All”or specific region in the same offer
11423	budget is error!	{ "country_code": "KB cannot set budget, you can only set budget on ALL or special country(AD,AE,AF,CN)!" }	you can only add budget for area you are targeting in offer
11423	budget is error!	{ "budget": "these (AD,AE,AF,CN) not set budget!" }	If you choose to maintain budget by area, must be sure you’ve set budget for all the area that offer is targeting，and it is forbidden to add different budget for same area in an offer
11423	budget is error!	{ "daily_cap_type": "daily_cap_type must be BUDGET or CONVERSION!" }	daily_cap_type Fields should be set as "BUDGET" or "CONVERSION"
11423	budget is error!	{ "daily_cap": "daily_cap is empty!" }	daily_cap Fields can’t be null
11423	budget is error!	{ "total_budget": "total_budget is empty!" }	total_budget Fields can’t be null
11423	budget is error!	{ "daily_cap": "daily_cap cannot less than 50!" }	Minimum daily_cap is 50