Modify The Splash Page Settings For The Given SSID

PUT {{baseUrl}}/networks/:networkId/wireless/ssids/:number/splash/settings

Modify the splash page settings for the given SSID #### Body Parameters Parameter|Type|Description :-------------: |:-------------: |:-------------: splashUrl| string| [optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl' useSplashUrl| boolean| [optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL. splashTimeout| integer| Splash timeout in minutes. This will determine how often users will see the splash page. redirectUrl| string| The custom redirect URL where the users will go after the splash page. useRedirectUrl| boolean| The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true. welcomeMessage| string| The welcome message for the users on the splash page. splashLogo| object| The logo used in the splash page. splashImage| object| The image used in the splash page. splashPrepaidFront| object| The prepaid front image used in the splash page. blockAllTrafficBeforeSignOn| boolean| How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged. controllerDisconnectionBehavior| string| How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'. allowSimultaneousLogins| boolean| Whether or not to allow simultaneous logins from different devices. guestSponsorship| object| Details associated with guest sponsored splash. billing| object| Details associated with billing splash.

Supports Action Batches

Request Body

{"splashUrl"=>"<string>", "useSplashUrl"=>"<boolean>", "splashTimeout"=>"<integer>", "redirectUrl"=>"<string>", "useRedirectUrl"=>"<boolean>", "welcomeMessage"=>"<string>", "splashLogo"=>{"md5"=>"<string>", "extension"=>"<string>"}, "splashImage"=>{"md5"=>"<string>", "extension"=>"<string>"}, "splashPrepaidFront"=>{"md5"=>"<string>", "extension"=>"<string>"}, "blockAllTrafficBeforeSignOn"=>"<boolean>", "controllerDisconnectionBehavior"=>"<string>", "allowSimultaneousLogins"=>"<boolean>", "guestSponsorship"=>{"durationInMinutes"=>"<integer>", "guestCanRequestTimeframe"=>"<boolean>"}, "billing"=>{"freeAccess"=>{"enabled"=>"<boolean>", "durationInMinutes"=>"<integer>"}, "prepaidAccessFastLoginEnabled"=>"<boolean>", "replyToEmailAddress"=>"<string>"}}

HEADERS

RESPONSES

status: OK

{"ssidNumber":0,"splashPage":"Click-through splash page","splashUrl":"https://www.custom_splash_url.com","useSplashUrl":true,"redirectUrl":"https://example.com","useRedirectUrl":true,"welcomeMessage":"Welcome!","splashLogo":{"md5":"abcd1234","extension":"jpg"},"splashImage":{"md5":null},"splashPrepaidFront":{"md5":null}}