Update the settings for the cap

HTTP method

Endpoint

PUT

/v1/offers/{offer_id}/caps

Path parameters

Parameter

Description

offer_id

The unique id for the offer.

Request body parameters

Field

Type

Description

Nullable

adv_cap_revenue

string

Advertiser cap revenue limit.

No

adv_cap_click

integer

Advertiser cap click limit.

No

adv_cap_type

integer

Cap type: 0 none ; 1 total_count ; 2 daily_count ; 3 revenue

No

adv_cap_conversion

integer

Advertiser cap conversion limit.

No

aff_cap_payout

string

Affiliate cap payout limit.

No

aff_cap_click

integer

Affiliate cap click limit

No

aff_cap_type

integer

Cap type: 0 none ; 1 total_count ; 2 daily_count ; 3 payout

No

aff_cap_conversion

integer

Affiliate cap conversion limit.

No

cap_timezone

string

Timezone

Response body parameters

Field

Type

Description

id

integer

offer_id

integer

A string that uniquely identifies this offer.

adv_cap_revenue

string

Advertiser cap revenue limit.

adv_cap_click

integer

Advertiser cap click limit.

adv_cap_type

integer

Cap type: 0 none ; 1 total_count ; 2 daily_count ; 3 revenue

adv_cap_conversion

integer

Advertiser cap conversion limit.

aff_cap_payout

string

Affiliate cap payout limit.

aff_cap_click

integer

Affiliate cap click limit

aff_cap_type

integer

Cap type: 0 none ; 1 total_count ; 2 daily_count ; 3 payout

aff_cap_conversion

integer

Affiliate cap conversion limit.

cap_timezone

string

Timezone selected.

Example request

Request PUT https://{networkname}.api.offerslook.com/v1/offers/3147/caps

Request PUT http://{networkname}.api.offerslook.com/v1/offers/3147/caps

    {
      "adv_cap_type": 1,
      "adv_cap_conversion": 100,
      "aff_cap_type": 1,
      "aff_cap_conversion": 90
    }

Example response

    {
      "code": 0,
      "message": "Success",
      "data": {
        "offer_cap": {
          "id": 102,
          "offer_id": 102,
          "cap_budget": null,
          "cap_click": null,
          "cap_type": null,
          "cap_conversion": null,
          "adv_cap_type": 1,
          "adv_cap_click": 100,
          "adv_cap_conversion": 0,
          "adv_cap_revenue": "0",
          "aff_cap_type": 1,
          "aff_cap_click": 90,
          "aff_cap_conversion": 0,
          "aff_cap_payout": "0.000",
          "cap_timezone": "Asia/Hong_Kong"
        }
      }
    }

Last updated