Products / Placements

Create a placement

Up to 1,000 per product. The response carries the new pl id

post/api/products/{productId}/placements

Request

  • Base URL: https://api.payware.eu
  • URL: https://api.payware.eu/api/products/{productId}/placements
  • Auth: HTTP bearer

Path parameters

productIdstring required

Request body

namestring required

Placement name, up to 100 characters

campaignIdstring

The campaign it belongs to, if any

mediumstring required

What the placement is: PRINT, PACKAGING, OUTDOOR, IN_STORE, EVENT, TV, RADIO, STREAMING, ONLINE, SOCIAL, EMAIL, SMS or OTHER

carriersstring[] required

The methods that carry it: QR, BARCODE, NFC, BLE, LINK, SMS, SOUNDBITE (airs the product's audio)

channelstring

Descriptive, e.g. the TV channel or the website, up to 100 characters

locationstring

Descriptive, e.g. the venue or the address, up to 255 characters

externalRefstring

An agency's own code, up to 100 characters

regionsstring[]

ISO 3166-1 alpha-2 codes of the countries it airs in; empty means anywhere. Matched against the paying bank's country

activeboolean

Whether it is in use. Governs airing and the soundbite attribution; a printed code keeps resolving until the placement is deleted

activeFromstring

Start of its active window, ISO-8601 with offset; empty means the product's

activeTostring

End of its active window, ISO-8601 with offset; empty means the product's

Example request

{
  "name": "Sofia metro posters, October",
  "campaignId": "cp7e4rCToG",
  "medium": "OUTDOOR",
  "carriers": [
    "QR",
    "NFC"
  ],
  "channel": "bTV",
  "location": "Serdika metro station",
  "regions": [
    "BG"
  ],
  "active": true,
  "activeFrom": "2026-10-15T00:00:00+03:00",
  "activeTo": "2026-12-31T23:59:59+02:00"
}

Response

Created

Changes

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