Edit Ad Entity
POST/api/advertising/campaigns/edit
Edits one campaign, ad group, item or target by submitting a manual change set with one line per lever you change. Nothing reaches the ad platform until the change set is approved; it then goes through caps, drift checks and can be undone.
advertising:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields
entity_type(required):campaign,ad_group,itemortarget.entity_id(required): the SKU.io ID of that entity.state(optional):enabled,pausedorarchived.budget(optional): daily budget, > 0 and ≤ 1,000,000 (campaigns).bid(optional): bid, > 0 and ≤ 100,000 (ad groups, items, targets).ad_rate(optional): ad rate percentage, > 0 and ≤ 100 (platforms that charge an ad rate, e.g. eBay General).target_value(optional): platform target such as tROAS, > 0 and ≤ 100,000.roi_target(optional): ROI target, > 0 and ≤ 1,000.dry_run(optional, default false): when true, returns asimulatedchange set with before/after values and any caps breached, and saves nothing to the platform.reason(optional, ≤ 1000 chars): recorded on the change set and each line.idempotency_key(optional, ≤ 80 chars): resubmitting with the same key returns the original change set instead of creating a duplicate. TheIdempotency-Keyheader is accepted as an alternative.
At least one lever must be set. Returns 201 with the new change set (status pending_approval), or 200 for a dry run or an idempotent replay. Returns 422 when no lever changes, the entity does not exist, or it is not linked to an ad account.
Requires the advertising.manage permission.
Also requires the advertising-manager feature (Advertising Manager plan); without it the endpoint returns 404.
Request
Responses
- 200
- 201
- 401
- 403
- 422
- 429
OK
Response Headers
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.