Sign in

v1

latestOpenAPI 3.0.12026-07-22204678550.0 KB
Campaign

/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets

Modify one or more existing active budgets to change their limitations or status. All three types of budgets can be modified.

The following constraints apply when modifying an existing budget.

• <b>campaignIds</b>: a non-empty subset of the original campaign ids MAY be supplied<br /> • <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br /> • <b>startDate</b>: a future start date MAY be supplied for budgets that have not yet started<br /> • <b>endDate</b>: an end date MAY be supplied and if supplied MUST be a future date greater than the start date<br />

Other attributes MUST NOT be supplied.

Adding new campaigns to a budget is not allowed. In addition, reducing the amount for a Capped budget to a value less than the current spend not allowed.

patch/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets

Request body

amountstring
budgetIdinteger
campaignIdsinteger[]
endDatestring
isSuspendedboolean
startDatestring date-time

Response

Success

amountnumber double nullable

Budget amount in the advertiser's currency

budgetTypestring

Type of budget: 'Daily' (daily cap), 'Capped' (lifetime with fixed amount), or 'Uncapped' (lifetime with no limit)

campaignIdsinteger[]

List of campaign IDs this budget applies to

endDatestring

End date of the budget period (format: YYYY-MM-DD), or empty string if open-ended

idstring

Unique budget identifier

isSuspendedboolean

Whether the budget has been manually suspended by the partner

sellerIdstring

Identifier of the seller this budget belongs to

spendnumber double nullable

Amount spent against this budget so far, or null if not available

startDatestring date

Start date of the budget period (format: YYYY-MM-DD)

status'Archived' | 'Current' | 'Scheduled'

Status of a seller budget

Example response

[
  {
    "id": "16501666",
    "sellerId": "10656107",
    "campaignIds": [
      436017
    ],
    "budgetType": "Capped",
    "amount": 462.47,
    "endDate": "2026-04-30",
    "spend": 117.59,
    "status": "Current",
    "isSuspended": false
  }
]