TwentyThree Developer APIAPI Method: /api/spot/update

API Method: /api/spot/update

Last updated on December 5, 2016.

Update a spot or landing page.

Parameters

ParameterDescription
spot_id (required)The ID for the spot to be updated.
spot_selectionSelection of videos, live event and other objects to include in th spot.
spot_nameThe name of the spot.
spot_typeThe type of the spot, can be set to page for landing pages and widget for embeddable spots.
spot_designThe design of the spot, valid options are carousel, ambient, thumbnails.
spot_layoutThe layout of the spot, valid options are grid, list, row.
thumbnail_styleThe style for thumbnails, valid options are inline_text, seperate_text, no_text.
playback_methodVideo playback method, valid options are link, player, popup.
video_countMaxium number of videos in the spot.
video_orderThe automatic ordering of videos.
product_spot_pBoolean indicating whether or not this is a product spot.
product_spot_pBoolean indicating whether or not this spot is active.
titleTitle for landing page.
contentPage content for landing page.
action_idID 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 updated" 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 updated",
  "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/update"
}