v1
latestOpenAPI 3.0.32026-07-2226694862.5 KBUpdate Offer Group
Update an existing offer group. Any omitted non-required fields will be reset to defaults.
Path parameters
The offer group ID.
Request body
Name of the offer group.
Status of the offer group.
ID of the advertiser for the offer group.
IDs of the offers to include in the offer group. The offers must belong to the specified advertiser.
Currency for the offer group. See the List Currencies endpoint for available values.
Labels to assign to this offer group.
Internal notes about the offer group.
Whether caps are enabled. When false, all cap values are ignored.
When true, caps are soft (tracking continues but a notification is sent). When false, caps are hard (tracking stops when the cap is reached).
Limit to the number of unique conversions in one day.
Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59).
Limit to the number of unique conversions in one month.
Limit to the total number of unique conversions at the offer level.
Limit to the affiliate's payout for one day.
Limit to the affiliate's payout for a week (Monday midnight to Sunday 23h59:59).
Limit to the affiliate's payout for one month.
Limit to the affiliate's total payout at the offer level.
Limit to the network's revenue for one day.
Limit to the network's revenue for a week (Monday midnight to Sunday 23h59:59).
Limit to the network's revenue for one month.
Limit to the network's total revenue at the offer level.
Limit to the number of unique clicks in one day.
Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).
Limit to the number of unique clicks in one month.
Limit to the total number of unique clicks at the offer level.
Response
Unique offer group ID.
Network ID.
ID of the advertiser for the offer group.
Name of the offer group.
Internal notes about the offer group.
Status of the offer group. Can be one of the following values: active, paused or deleted.
Whether caps are enabled. When false, voids all types of caps and custom caps.
Limit to the number of unique conversions in one day.
Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59).
Limit to the number of unique conversions in one month.
Limit to the total number of unique conversions at the offer level.
Limit to the affiliate's payout for one day.
Limit to the affiliate's payout for a week (Monday midnight to Sunday 23h59:59).
Limit to the affiliate's payout for one month.
Limit to the affiliate's total payout at the offer level.
Limit to the network's revenue for one day.
Limit to the network's revenue for a week (Monday midnight to Sunday 23h59:59).
Limit to the network's revenue for one month.
Limit to the network's total revenue at the offer level.
Limit to the number of unique clicks in one day.
Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).
Limit to the number of unique clicks in one month.
Limit to the total number of unique clicks at the offer level.
Unix timestamp of creation.
Unix timestamp of last update.
Whether soft caps are enabled for this offer group.
Example response
{
"time_created": 1734455015,
"time_saved": 1734455015,
"relationship": {
"advertiser": {
"time_created": 1734455015,
"time_saved": 1734455015
}
}
}