---
title: "Set campaign action capping"
type: reference
method: POST
path: /rest-api/campaign/{campaignId}/action-capping/set.do
tag: "Capping"
---

# Set campaign action capping

`POST https://YOUR-NETWORK-DOMAIN/rest-api/campaign/{campaignId}/action-capping/set.do`

Creates a new action (conversion) capping rule for a campaign, limiting how many conversions are counted within a time window. A new capping record is always created (multiple rules can coexist for different subject types). The response JSON contains the newly created capping record ID in the 'id' field. Requires UPDATE permission and the MANAGE_CAPPING_AND_LIMITATIONS privilege; using IP or LES_IP subjects requires additional permissions.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `campaignId` | integer | yes | `2001` | Numeric ID of the campaign to configure action capping for |

## Form params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `period` | integer | yes | `24` | Length of the capping time window, expressed in units defined by periodType |
| `periodType` | string | yes | `HOUR` | Unit of the capping period. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR |
| `amount` | integer | no | `1000` | Maximum number of conversions allowed within the specified period. Optional; if omitted the capping has no amount limit. |
| `evenDistribution` | boolean | no | `true` | When true, conversions are distributed evenly across the period instead of being counted as fast as possible |
| `subject` | string | no | `USER_COOKIE` | Entity used to identify unique users for capping. Defaults to USER_COOKIE if omitted. Allowed values: USER_COOKIE, USER_SERVER_SIDE, USER_MIXED, IP, LES_IP |

## Responses

- `200` — Action capping set successfully
- `400` — Invalid request parameters
- `401` — Authentication error
- `403` — Not enough permissions
- `404` — Campaign not found

## Example request

```bash
curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/action-capping/set.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'period=24' \
  --data-urlencode 'periodType=HOUR' \
  --data-urlencode 'amount=1000' \
  --data-urlencode 'evenDistribution=true' \
  --data-urlencode 'subject=USER_COOKIE'
```

Source: https://epom.com/ad-server/docs/api/capping/post-campaign-action-capping-set