Partial update adslot

Partially updates Adslot owned by logged-in Publisher

Request

PATCH https://api.convertiser.com/publisher/adslots/{uuid}/

Path parameters

Parameter name Value Description Additional
uuid string Required

Request body

The request body takes a complete Adslot resource, containing the following writable properties:

{
    "_version": "integer",
    "config": "string",
    "filters": [
        {
            "any": "string",
            "brand": "string",
            "category": "string",
            "cpc_rate": "string",
            "currency": "string",
            "description": "string",
            "discount": "string",
            "feed_id": "string",
            "gtin": "string",
            "id": "string",
            "is_cpc": "string",
            "mpn": "string",
            "offer": "string",
            "offer_id": "string",
            "price": "string",
            "sale_price": "string",
            "search_field": "string",
            "status": "string",
            "title": "string",
            "updated_at": "string"
        }
    ],
    "title": "string",
    "type": "string",
    "website": "string",
    "widgets": [
        {
            "embed_code": "string",
            "height": "integer",
            "id": "string",
            "item_type": "string",
            "token": "string",
            "url": "string",
            "width": "integer",
            "x": "integer",
            "y": "integer"
        }
    ]
}

Properties

Name Type Description Additional
_version integer

Optimistic Object Lock
config string

AdSlot Configuration

 Optional
filters[] array

AdSlot search filters

 Optional
filters[].any string Optional
filters[].brand string Optional
filters[].category string Optional
filters[].cpc_rate string Optional
filters[].currency string Optional
filters[].description string Optional
filters[].discount string Optional
filters[].feed_id string Optional
filters[].gtin string Optional
filters[].id string Optional
filters[].is_cpc string Optional
filters[].mpn string Optional
filters[].offer string Optional
filters[].offer_id string Optional
filters[].price string Optional
filters[].sale_price string Optional
filters[].search_field string Optional
filters[].status string Optional
filters[].title string Optional
filters[].updated_at string Optional
title string

Adslot title

 Optional
type string

Possible values are:

  • filter
  • manual
 Optional
website string Optional
widgets[] array

AdSlot widgets

 Optional
widgets[].embed_code string Optional
widgets[].height integer Optional
widgets[].id string Optional
widgets[].item_type string Optional
widgets[].token string Optional
widgets[].url string Optional
widgets[].width integer Optional
widgets[].x integer Optional
widgets[].y integer Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK Adslot

Explore this API

uuid
data
Request Content-Type
Response Content-Type

Choose an authorisation method:

API Token API Token to be used for request
Try it out!