Sign in
Players > Ads

Create an ads

This endpoint allows you to create a new Ads.

post/1/videos/{channel}/players/{player}/ads

Path parameters

channelinteger required

The unique identifier (ID) of the channel to request.

playerinteger required

The unique identifier (ID) of the player to request.

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

account_idinteger required

Account identifier

The account identifier

Request body

is_periodicboolean

boolean to determine if ad should cycle

offsetinteger required

the offset to play the ad

type'mid-roll' | 'pre-roll' required

the ad type to play the ad

urlstring required

the url of the vast XML

Example request

{
  "type": "\"toto\"",
  "url": "\"Hello world ! 😊\""
}

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success",
  "data": {
    "id": 1
  }
}

Changes

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