Insertion Policy API

Note: The Insertion Policy API works only with the new Insertion Policy functionality. For more information, refer to Insertion Policies and Using Insertion Policies.

Getting Started

  • Base URL: https://api.videoplaza.com/v0/insertion-policy
  • Requests: GET, POST, PUT, and DELETE requests are used. You pass parameters by using common REST parameters like PATH and QUERY, as well as HTTP HEADERS. The body of the requests should be provided in JSON format and encoded using UTF-8.
  • Responses: All responses contain an HTTP status code in the header and the body is in JSON format.
  • Swagger documentation: https://api.videoplaza.com/v1/swagger
  • Related user documentation:
Note: Only successful responses are shown in the examples. Details about unsuccessful responses are found in the swagger documentation.

Retrieve Insertion Policy Template

Method GET
URL https://api.videoplaza.com/v0/insertion-policy/template
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: insertion policy template with all available parameters and their default values

{
    "globalSettings": {
        "skipButton": {
            "showWhen": "NEVER",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 0,
                "unit": "SECONDS"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "midroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "postroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": false
    },
    "overlaySettings": {
        "enabled": false,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
  "name": "<string>",
    "description": "<string>"
}

Example:

Request header:

GET /v0/insertion-policy/template HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

{
    "globalSettings": {
        "skipButton": {
            "showWhen": "NEVER",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 0,
                "unit": "SECONDS"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "midroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "postroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": false
    },
    "overlaySettings": {
        "enabled": false,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
  "name": "<string>",
    "description": "<string>"
}

Create Insertion Policy

Method POST
URL https://api.videoplaza.com/v0/insertion-policy
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body Insertion policy template
Note: Only the name parameter is required.
Success response

HTTP status: 201 Created

Header: Location: URI to the location of your insertion policy

Body: insertion policy including insertion policy ID

Example:

Request header:

POST /v0/insertion-policy HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body:

{
    "globalSettings": {
        "skipButton": {
            "showWhen": "ALWAYS",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 3,
                "unit": "SECONDS"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 2
        },
        "midroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 3
        },
        "postroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": true
    },
    "overlaySettings": {
        "enabled": true,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
  "name": "Default policy",
  "description": "The standard policy to use."
}

Success response:

HTTP status:
  201 (Created)

Header:
  Location: <URI with the location of your insertion policy>

Body:
{
    "id": "f3934388-841e-4024-8445-c6e529e96b4b",
    "site": "9391fd87-f72c-343a-88c5-4773cc525269",
    "globalSettings": {
        "skipButton": {
            "showWhen": "ALWAYS",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 3,
                "unit": "SECONDS"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 2
        },
        "midroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 3
        },
        "postroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": true
    },
    "overlaySettings": {
        "enabled": true,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
    "name": "Default policy",
    "description": "The standard policy to use."
}

Update Insertion Policy

Method PUT
URL https://api.videoplaza.com/v0/insertion-policy
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body Insertion policy template
Note: You must pass in the insertion policy ID.
Success response

HTTP status: 200 OK

Header: -

Body: insertion policy with insertion policy ID

Example:

Request header:

PUT /v0/insertion-policy HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body:

{
    "id": "f3934388-841e-4024-8445-c6e529e96b4b",
    "globalSettings": {
        "skipButton": {
            "showWhen": "AFTER_FIRST_UNIQUE",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 30,
                "unit": "PERCENT"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 2
        },
        "midroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 3
        },
        "postroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": true
    },
    "overlaySettings": {
        "enabled": true,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
    "name": "Default policy",
    "description": "The standard policy to use."
}

Success response:

HTTP status:
  200 (OK)

Body:
{
    "id": "f3934388-841e-4024-8445-c6e529e96b4b",
    "site": "9391fd87-f72c-343a-88c5-4773cc525269",
    "globalSettings": {
        "skipButton": {
            "showWhen": "AFTER_FIRST_UNIQUE",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 30,
                "unit": "PERCENT"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 2
        },
        "midroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 3
        },
        "postroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "seekroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": true
    },
    "overlaySettings": {
        "enabled": true,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
    "name": "Default policy",
    "description": "The standard policy to use."
}

List Insertion Policies

Use this to retrieve a paginated list of all insertion policies belonging to your site. By default, without adding any query parameters, you get a list of the first 10 insertion policies.

Method GET
URL https://api.videoplaza.com/v0/insertion-policy
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params
  • pageSize=<integer>: specify the number of insertion policies listed per one page.
  • pageNumber=<integer>: list insertion policies by page number. If you do not define the pageSize=<integer> query parameter, you get a list of 10 insertion policies per defined page.
Body -
Success response

HTTP status: 200 OK

Header: -

Body: list of insertion policies

Example:

Request header:

GET /v0/insertion-policy?pageSize=15&pageNumber=2 HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

{
    "data": [
        {
            "id": "67077787-9234-4697-b314-de26da2ae131",
            "site": "9391fd87-f72c-343a-88c5-4773cc525269",
            "globalSettings": {
                "skipButton": {
                    "showWhen": "AFTER_FIRST_UNIQUE",
                    "resetAfter": 86400,
                    "skipOffset": {
                        "value": 30,
                        "unit": "PERCENT"
                    }
                },
                "minimumTimeBetweenAds": 180
            },
            "adBreakSettings": {
                "standardSpotsEnabled": true,
                "interactiveSpotsEnabled": false,
                "preroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 2
                },
                "midroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 3
                },
                "postroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "seekroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1,
                    "minSeekEvents": 3
                }
            },
            "pauseAdSettings": {
                "enabled": true
            },
            "overlaySettings": {
                "enabled": true,
                "duration": 15,
                "firstInsertion": 20,
                "frequency": 180
            },
            "name": "Default policy",
            "description": "The standard policy to use."
        },
        {
            "id": "63b5bda5-07b6-49ae-92d5-3045dcc9b9ec",
            "site": "9391fd87-f72c-343a-88c5-4773cc525269",
            "globalSettings": {
                "skipButton": {
                    "showWhen": "NEVER",
                    "resetAfter": 86400,
                    "skipOffset": {
                        "value": 0,
                        "unit": "SECONDS"
                    }
                },
                "minimumTimeBetweenAds": 180
            },
            "adBreakSettings": {
                "standardSpotsEnabled": true,
                "interactiveSpotsEnabled": false,
                "preroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 4
                },
                "midroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "postroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 4
                },
                "seekroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 2,
                    "minSeekEvents": 3
                }
            },
            "pauseAdSettings": {
                "enabled": true
            },
            "overlaySettings": {
                "enabled": true,
                "duration": 15,
                "firstInsertion": 20,
                "frequency": 180
            },
            "name": "High ad load",
            "description": "This policy will deliver a high ad load, use only for longer content."
        },
        {
            "id": "38921131-f1aa-4510-8957-7021d866eb62",
            "site": "9391fd87-f72c-343a-88c5-4773cc525269",
            "globalSettings": {
                "skipButton": {
                    "showWhen": "NEVER",
                    "resetAfter": 86400,
                    "skipOffset": {
                        "value": 0,
                        "unit": "SECONDS"
                    }
                },
                "minimumTimeBetweenAds": 180
            },
            "adBreakSettings": {
                "standardSpotsEnabled": true,
                "interactiveSpotsEnabled": false,
                "preroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "midroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "postroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "seekroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1,
                    "minSeekEvents": 3
                }
            },
            "pauseAdSettings": {
                "enabled": false
            },
            "overlaySettings": {
                "enabled": false,
                "duration": 15,
                "firstInsertion": 20,
                "frequency": 180
            },
            "name": "Low ad load",
            "description": "Use for content that should have low ad load."
        },
        {
            "id": "6c26c77c-ca81-4ffc-acf0-cc780ea5470b",
            "site": "9391fd87-f72c-343a-88c5-4773cc525269",
            "globalSettings": {
                "skipButton": {
                    "showWhen": "AFTER_FIRST_UNIQUE",
                    "resetAfter": 86400,
                    "skipOffset": {
                        "value": 3,
                        "unit": "SECONDS"
                    }
                },
                "minimumTimeBetweenAds": 180
            },
            "adBreakSettings": {
                "standardSpotsEnabled": true,
                "interactiveSpotsEnabled": false,
                "preroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 3
                },
                "midroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 3
                },
                "postroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 2
                },
                "seekroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1,
                    "minSeekEvents": 3
                }
            },
            "pauseAdSettings": {
                "enabled": true
            },
            "overlaySettings": {
                "enabled": true,
                "duration": 15,
                "firstInsertion": 20,
                "frequency": 180
            },
            "name": "Medium ad load",
            "description": "This policy is used for content where we need to use a medium ad load."
        },
        {
            "id": "881b87c3-bca5-4a33-bada-f7c3998c4858",
            "site": "9391fd87-f72c-343a-88c5-4773cc525269",
            "globalSettings": {
                "skipButton": {
                    "showWhen": "ALWAYS",
                    "resetAfter": 86400,
                    "skipOffset": {
                        "value": 3,
                        "unit": "SECONDS"
                    }
                },
                "minimumTimeBetweenAds": 180
            },
            "adBreakSettings": {
                "standardSpotsEnabled": true,
                "interactiveSpotsEnabled": false,
                "preroll": {
                    "enabled": true,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "midroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "postroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1
                },
                "seekroll": {
                    "enabled": false,
                    "timeLimit": {
                        "enabled": false,
                        "seconds": 30
                    },
                    "adsPerBreak": 1,
                    "minSeekEvents": 3
                }
            },
            "pauseAdSettings": {
                "enabled": false
            },
            "overlaySettings": {
                "enabled": false,
                "duration": 15,
                "firstInsertion": 20,
                "frequency": 180
            },
            "name": "Short clips",
            "description": "This policy is for short news clips no longer than 30 seconds."
        }
    ],
    "pagination": {
        "totalCount": 20,
        "pageSize": 15,
        "pageNumber": 2
    }
}

List Insertion Policies by Insertion Policy ID

Method GET
URL https://api.videoplaza.com/v0/insertion-policy/{id}
Header Authentication header (x-o-api-key)
Content type application/json
URL params Insertion policy ID
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: specified insertion policy

Example:

Request header:

GET /v0/insertion-policy/63b5bda5-07b6-49ae-92d5-3045dcc9b9ec HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

{
    "id": "63b5bda5-07b6-49ae-92d5-3045dcc9b9ec",
    "site": "9391fd87-f72c-343a-88c5-4773cc525269",
    "globalSettings": {
        "skipButton": {
            "showWhen": "NEVER",
            "resetAfter": 86400,
            "skipOffset": {
                "value": 0,
                "unit": "SECONDS"
            }
        },
        "minimumTimeBetweenAds": 180
    },
    "adBreakSettings": {
        "standardSpotsEnabled": true,
        "interactiveSpotsEnabled": false,
        "preroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 4
        },
        "midroll": {
            "enabled": false,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 1
        },
        "postroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 4
        },
        "seekroll": {
            "enabled": true,
            "timeLimit": {
                "enabled": false,
                "seconds": 30
            },
            "adsPerBreak": 2,
            "minSeekEvents": 3
        }
    },
    "pauseAdSettings": {
        "enabled": true
    },
    "overlaySettings": {
        "enabled": true,
        "duration": 15,
        "firstInsertion": 20,
        "frequency": 180
    },
    "name": "High ad load",
    "description": "This policy will deliver a high ad load, use only for longer content"
}

Connect Insertion Policies to Categories, Device Containers, and Content Play Length

Method POST
URL https://api.videoplaza.com/v0/insertion-policy/targeting
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body
{
  "shortFormInsertionPolicyId": "<string>",
  "longFormInsertionPolicyId": "<string>",
  "deviceContainerId": "<string>",
  "categoryId": "<string>"
}
Note: all parameters are required except longFormInsertionPolicyId.
Success response

HTTP status: 200 OK

Header: -

Body:

{
  "shortFormInsertionPolicyId": "<string>",
  "longFormInsertionPolicyId": "<string>",
  "deviceContainerId": "<string>",
  "categoryId": "<string>"
}

Example:

Request header:

POST /v0/insertion-policy/targeting HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body:

{
  "shortFormInsertionPolicyId": "67077787-9234-4697-b314-de26da2ae131",
  "longFormInsertionPolicyId": "63b5bda5-07b6-49ae-92d5-3045dcc9b9ec",
  "deviceContainerId": "5faffabd-fd8f-47f8-9360-49a98b399ea1",
  "categoryId": "714acf8c-7de6-4e7f-8460-1ec5215b8124"
}

Success response:

HTTP status:
  200 (OK)

Body:
{
  "shortFormInsertionPolicyId": "67077787-9234-4697-b314-de26da2ae131",
  "longFormInsertionPolicyId": "63b5bda5-07b6-49ae-92d5-3045dcc9b9ec",
  "deviceContainerId": "5faffabd-fd8f-47f8-9360-49a98b399ea1",
  "categoryId": "714acf8c-7de6-4e7f-8460-1ec5215b8124"
}

Filter Targeting by Category, Device Container, or Insertion Policy

Method GET
URL https://api.videoplaza.com/v0/insertion-policy/targeting
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params
  • deviceContainerId
  • categoryId
  • insertionPolicyId
Body -
Success response

HTTP status: 200 OK

Header: -

Body: paginated list of device container, category, short/long form insertion policy combinations

{
    "data": [
        {
            "deviceContainerId": "<string>",
            "categoryId": "<string>",
            "shortFormInsertionPolicyId": "<string>",
            "longFormInsertionPolicyId": "<string>"
        },
        {
            "deviceContainerId": "<string>",
            "categoryId": "<string>",
            "shortFormInsertionPolicyId": "<string>",
            "longFormInsertionPolicyId": "<string>"
        }
    ],
    "pagination": {
        "totalCount": "<integer>",
        "pageSize": "<integer>",
        "pageNumber": "<integer>"
    }
}

Example:

Request header:

GET /v0/insertion-policy/targeting?categoryId=714acf8c-7de6-4e7f-8460-1ec5215b8124 HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
{
    "data": [
        {
            "deviceContainerId": "6b6535fb-7ca3-4aea-a783-92f99e698d4c",
            "categoryId": "714acf8c-7de6-4e7f-8460-1ec5215b8124",
            "shortFormInsertionPolicyId": "67077787-9234-4697-b314-de26da2ae131",
            "longFormInsertionPolicyId": "63b5bda5-07b6-49ae-92d5-3045dcc9b9ec"
        },
        {
            "deviceContainerId": "5faffabd-fd8f-47f8-9360-49a98b399ea1",
            "categoryId": "714acf8c-7de6-4e7f-8460-1ec5215b8124",
            "shortFormInsertionPolicyId": "67077787-9234-4697-b314-de26da2ae131"
        }
    ],
    "pagination": {
        "totalCount": 2,
        "pageSize": 10,
        "pageNumber": 1
    }
}

Delete Insertion Policy Connection to Category and Device Container

Method DELETE
URL https://api.videoplaza.com/v0/insertion-policy/targeting
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params Both query parameters are required:
  • deviceContainerId
  • categoryId
Body -
Success response

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

DELETE /v0/insertion-policy/targeting?categoryId=714acf8c-7de6-4e7f-8460-1ec5215b8124&deviceContainerId=5faffabd-fd8f-47f8-9360-49a98b399ea1 HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  204 (No Content)

Was this article helpful?