API Method: /api/spot/create
Create a new spot or landing page.
Parameters
| Parameter | Description |
|---|---|
| spot_name (required) | The name of the spot. |
| spot_type (required) | The type of the spot, can be set to page for landing pages and widget for embeddable spots. |
| spot_selection | Selection of videos, live event and other objects to include in th spot. |
| spot_design | The design of the spot, valid options are carousel, ambient, thumbnails. |
| spot_layout | The layout of the spot, valid options are grid, list, row. |
| thumbnail_style | The style for thumbnails, valid options are inline_text, seperate_text, no_text. |
| video_count | Maxium number of videos in the spot. |
| video_order | The automatic ordering of videos. |
| playback_method | Video playback method, valid options are link, player, popup. |
| product_spot_p | Boolean indicating whether or not this is a product spot. |
| title | Title for landing page. |
| content | Page content for landing page. |
| action_id | ID identifying a collector action to be used with the spot or landing page. |
Permission level
The minimum required permission level is:
write
Example XML Response
<response status="ok" permission_level="write"
message="The spot was successfully created" cached="0">
<spot_id>123456</live_id>
<token>hqzry7xaaekyavpjghpZkt1ykbelKjai</token>
<spot_name>Your spot name</token>
<url_stub>your-spot-name</token>
</response>
Example JSON Response
{
"status": "ok",
"message":"The spot was successfully created",
"permission_level":"write",
"cached":"0",
"spot":{
"spot_id": "123456",
"token": "hqzry7xaaekyavpjghpZkt1ykbelKjai",
"title": "Your spot name",
"url_stub": "/your-spot-name"
},
"p": "1",
"size": "1",
"site": { ...},
"endpoint": "/api/spot/create"
}