Campaigns

Replace a campaign's details

Replaces name, dates and external reference; a missing status keeps the current one

put/api/campaigns/{campaignId}

Request

  • Base URL: https://api.payware.eu
  • URL: https://api.payware.eu/api/campaigns/{campaignId}
  • Auth: HTTP bearer

Path parameters

campaignIdstring required

Request body

namestring required

Campaign name, up to 100 characters

startsOnstring

First day, YYYY-MM-DD

endsOnstring

Last day, YYYY-MM-DD

statusstring

DRAFT, ACTIVE or ENDED. Descriptive: it does not switch placements on or off

externalRefstring

An agency's own campaign code, up to 100 characters

Example request

{
  "name": "Autumn TV 2026",
  "startsOn": "2026-10-15",
  "endsOn": "2026-12-31",
  "status": "ACTIVE",
  "externalRef": "AGY-2026-117"
}

Response

Updated

Changes

No recorded changes to this operation across all 1 revision of this API.