Search...
Menu

API: Managing Offers (Technical Guide)

Label：API ,API key ,updating offers ,technical guide ,developer guide

You need to use your Mintegral token to manage your offers. For more details, please check Token.

Here's how you can manage the basic information of an offer, such as promotion time, target geo, etc.

Request address

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

Request method

PUT

Request example

json Copy 
PUT /api/open/v1/offer
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
  "offer_id": "18490",
  "offer_name": "cqf_testtttt",
  "promote_timezone": 7,
  "start_time": 1578455012,
  "target_geo": "ALL",
  "os_version_min": "8.8",
  "custom_ad_schedule": {"1":"0,1,23","2":"3,4,5","3":"3,6,5"},
  "custom_ad_schedule_timezone": 0,
  "network": "WIFI",
  "target_device": "PHONE"
}

Request Parameter

Fields Type Explanations Default Value Examples
offer_id int Unique id for offer — 1234
offer_name string Unique name for offer. Only alphabets, underscores and numbers are allowed. Length within 3~95. "" "offer_test"
promote_timezone number Timezone setting for promotion period,Enum value in
[ENUM-Timezone]		 "" 5.5
start_time int Timestamp of promotion start time. Must be earlier than end_time (if any). — 1578455012
end_time Optional int Timestamp of promotion end time. Must be after start_time (if any). 0 1578455169
target_geo string Target geos for promotion. Set "ALL" for global promotion. Separate with commas for multiple geos. — "CN"
os_version_min Optional string Minimum OS version allowed in format of /^[0-9](\.[0-9]){0,2}$/ . "x" as in natural number. If set null, OS version requirement will be same as campaign by default. — "9.0"
custom_ad_schedule Optional json Promotion schedule. Key means weekday (1-7) and value means hour (0-23). Set null to select all weekdays and all hours. — {"1":"0,1,23","2":"3,4,5"}
custom_ad_schedule_timezone Deprecated number Timezone setting for promotion schedule.Enum value in
[ENUM-Timezone] This field has been deprecated, use the 'promote_timezone' field instead.		 — -5.5
network Optional string Target for device network status. Enum value in
[ENUM-Network]		 — "2G,3G,4G,5G"
target_device Optional string Target device type. ENUM value: "PHONE" 、"TABLET"。 "PHONE,TABLET" "PHONE,TABLET"

Response

Fields Type Explanations
code int 200 code, is success. Others, are fail.
msg string If success, return "success". If fail, return to detailed wrong info.
data json If success, return offer data. If fail, return to detailed wrong info.
offer_id int Unique id for offer
offer_name string Offer name you set
promote_timezone number Timezone setting for promotion period, such as -5
start_time int Timestamp of promotion start time.
end_time int Timestamp of promotion end time.
target_geo string Target geos for promotion.such as US,CN
os_version_min string Minimum OS version
custom_ad_schedule string Promotion schedule
custom_ad_schedule_timezone number Timezone setting for promotion schedule
This field has been deprecated, use the 'promote_timezone' field instead.
network string Target for device network status
target_device string Target device type

Response Example

json Copy 
{
  "code": 200,
  "msg": "success",
  "data": {
    "offer_id": 18496,
    "offer_name": "cqf_testtttt",
    "promote_timezone": 7,
    "start_time": "1578455012",
    "end_time": "1578458012",
    "target_geo": "ALL",
    "os_version_min": "8.8",
    "custom_ad_schedule": "{\"1\":\"0,1,23\",\"2\":\"3,4,5\",\"3\":\"3,6,5\"}",
    "custom_ad_schedule_timezone": 0,
    "network": "WIFI",
    "target_device": "PHONE"
  }
}
Previous
API: Creating Offers (Technical Guide)
Next
API: Managing Bids (Technical Overview)
Last modified: 2025-08-28