OTotto
SponsoredProductAds V1

Update campaign

Changed on

Partially updates a campaign using JSON Merge Patch (RFC 7386). Only include the fields you want to change; omitted fields remain unchanged. Setting a nullable field to null clears its value.

patch/v1/sponsored-product-ads/campaigns/{campaignId}

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/sponsored-product-ads/campaigns/{campaignId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring uuid required
Example:00000001-0000-4000-8000-000000000001

Unique campaign identifier.

Request body

namestring

Campaign display name. Must not contain $, §, ", #, *, or parentheses — except for an optional trailing numeric suffix (e.g. My campaign (2)).

startDatestring date

Campaign start date. Must be today or a future date.

endDatestring date nullable

Campaign end date. Must be at least one day after today. May be null for ongoing campaigns; however, null is not allowed when budgetType is LIFETIME.

pacing'ASAP' | 'EVEN'
status'WAITING' | 'ACTIVE' | 'PAUSED'

Example request

{
  "name": "My awesome campaign",
  "startDate": "2026-04-28",
  "endDate": "2026-10-28"
}

Response

Campaign update accepted.

Example response

{
  "_links": {
    "self": {
      "href": "https://api.otto.market/v1/sponsored-product-ads/campaigns/00000001-0000-4000-8000-000000000001"
    },
    "change-request": {
      "href": "https://api.otto.market/v1/sponsored-product-ads/campaigns/00000001-0000-4000-8000-000000000001"
    }
  }
}

Changes