> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/network/network-api/capping-api.md).

# Capping API

{% code overflow="wrap" %}

```
POST https://api.offer18.com/api/m/offer_capping
```

{% endcode %}

### Common Parameters

| Query      | Type    | Description        |
| ---------- | ------- | ------------------ |
| mid        | Integer | Network Account ID |
| api-key    | String  | Network API Key    |
| secret-key | String  | Network Secret Key |

**Action**

| Query     | Type    | Description                                  |
| --------- | ------- | -------------------------------------------- |
| action    | String  | **Allowed Values:** create / update / delete |
| offer\_id | Integer | Required for all actions                     |

###

### Filter

<table><thead><tr><th>Query</th><th width="249">Type</th><th>Description</th></tr></thead><tbody><tr><td>rule_id</td><td>Integer</td><td>Id of the Capping Rule</td></tr><tr><td>status</td><td>String</td><td>enable/disable</td></tr><tr><td>limit</td><td>Integer</td><td>Number of Capping Rules per page (max 30 rules)</td></tr><tr><td>page</td><td>Integer</td><td>Page Number</td></tr></tbody></table>

####

{% code overflow="wrap" %}

```
https://api.offer18.com/api/m/offer_capping?mid=000&api-key=000000&secret-key=000000000&action=create
```

{% endcode %}

###

### Fields

<table><thead><tr><th>Query</th><th>Type</th><th width="263">Description</th></tr></thead><tbody><tr><td>offer_id</td><td>Integer</td><td>Offer ID</td></tr><tr><td>rule_name</td><td>String</td><td>Capping Rule Name</td></tr><tr><td>rule_type</td><td>String</td><td><ul><li>advertiser_capping</li><li>affiliate_capping</li></ul></td></tr><tr><td>affiliate_id</td><td>Integer</td><td>Affiliate ID if affiliate capping</td></tr><tr><td>timezone</td><td>Integer</td><td>Capping Timezone</td></tr><tr><td>capping_type</td><td>String</td><td><ul><li>gross_conversions</li><li>approved_conversions</li><li>gross_revenue</li><li>approved_revenue</li><li>gross_payout</li><li>approved_payout</li><li>gross_clicks</li><li>approved_clicks</li></ul></td></tr><tr><td>capping_period</td><td>String</td><td><ul><li>daily</li><li>weekly</li><li>monthly</li><li>hourly</li></ul></td></tr><tr><td>capping_value</td><td>Integer</td><td>Capping Value</td></tr><tr><td>overcap_action</td><td>String</td><td><ul><li>stop</li><li>fallback</li><li>fallback_conversion_accept</li><li>conversion_accept</li><li>conversion_reject</li><li>conversion_pending</li></ul></td></tr><tr><td>event</td><td>String</td><td>Event for event capping</td></tr><tr><td>affiliate_visibility</td><td>String</td><td><ul><li>show</li><li>hide</li></ul></td></tr><tr><td>notification_email</td><td>String</td><td>Email ID for capping notification</td></tr><tr><td>notification_earlier_threshold</td><td>String</td><td>Email ID for capping threshold notification</td></tr><tr><td>status</td><td>String</td><td><p>Capping Rule Status</p><ul><li>enable</li><li>disable</li></ul></td></tr><tr><td>rule_id</td><td>Integer</td><td>To update and delete the capping rule</td></tr></tbody></table>

## Example API Request <a href="#example-api-request" id="example-api-request"></a>

<figure><img src="/files/dadl2M7ngTqn2weEXj4M" alt=""><figcaption></figcaption></figure>

### API Response <a href="#api-response" id="api-response"></a>

{% code overflow="wrap" %}

```javascript
{
    "status": 200,
    "response": "capping_rule_created_successfully",
    "data": {
        "rule_id": 70xxx1
    }
}
```

{% endcode %}

<br>