/v{version}/Content/WebsiteSpots

Prev Next
Post
/v{version}/Content/WebsiteSpots
Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.20"
Body parameters
Expand All
object

Request model for creating a new website spot

Duration
integer (int32) Required

Duration in seconds for which the spot is active.

Minimum1
Maximum2147483647
LocationId
integer (int32)

Unique ID of the location associated with the spot.

Minimum1
Maximum2147483647
Name
string Required

Name of the spot

PlayerId
integer (int32)

Unique ID of the player associated with the spot.

Minimum1
Maximum2147483647
SpotGroupId
integer (int32)

Unique ID of the spot group where the spot is placed in.

Minimum1
Maximum2147483647
Website
object (V1.Models.AddWebsiteSpotRequestWebsite) Required

Website details for the spot creation request.

HeadersPreloadingEnabled
boolean Required

Indicates whether headers preloading is enabled for the website.

Url
string Required

URL of the website to be displayed in the spot.

Responses
200

OK

integer (int32)
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties