updateSiteWlanPortalTemplate

PUT https://{{host}}/api/v1/sites/:site_id/wlans/:wlan_id/portal_template

Body Parameters

Parameter	Type	Description
pageTitle	string	'Welcome'
message	string	'Please enjoy the complimentary Wifi'
color	string	'#1074bc'
colorDark	string	'#0b5183'
colorLight	string	'#3589c6'
alignment	string	defines alignment on portal. 'left' is default.
passphraseLabel	string	Passphrase
passphraseError	string	error message when invalid passphrase is provided
tos	boolean	default is true
tosText	string	text of the Terms of Service
tosAcceptLabel	string	prefix of the label of the link to go to /tos
tosLink	string	label of the link to go to /tos
tosError	string	error message when tos not accepted
backLink	string	label of the link to go back to /logon
signInLabel	string	label of the button to /signin
poweredBy	string	whether to show 'Powered by Mist', default is true
email	boolean	whether email field is required, default is false
emailLabel	string	label of email field
emailError	string	error message when email not provided
name	boolean	whether name field is required, default is false
nameLabel	string	label of name field
nameError	string	error message when name not provided
company	boolean	whether company field is required, default is false
companyLabel	string	label of company field
companyError	string	error message when company not provided
requiredFieldLabel	string	label to denote required field
field1	boolean	whether to ask field1
field1Label	string	label of field1
field1Required	boolean	whether field1 is required field
field1Error	string	error message when field1 not provided
field2	boolean	whether to ask field2
field2Label	string	label of field2
field2Required	boolean	whether field2 is required field
field2Error	string	error message when field2 not provided
field3	boolean	whether to ask field3
field3Label	string	label of field3
field3Required	boolean	whether field3 is required field
field3Error	string	error message when field3 not provided
field4	boolean	whether to ask field4
field4Label	string	label of field4
field4Required	boolean	whether field4 is required field
field4Error	string	error message when field4 not provided
optout	boolean	whether to display 'Do Not Store My Personal Information'
optoutLabel	string	label for 'Do Not Store My Personal Information'
authButtonPassphrase	string	label for passphrase auth button
passphraseTitle	string	Title for passphrase details page
passphraseMessage	string	'Login using passphrase'
passphraseSubmit	string	'Sign in'
passphraseCancel	string	'Cancel'
authButtonGoogle	string	label for Google auth button
authButtonFacebook	string	label for Facebook auth button
authButtonSms	string	label for SMS auth button
emailAccessDomainError	string	error message when a user has valid social login but doesn't match specified email domains.
smsNumberFieldLabel	string	label for field to provide mobile number
smsCarrierFieldLabel	string	label for mobile carrier drop-down list
smsNumberSubmit	string	label for submit button for code generation
smsNumberCancel	string	label for canceling mobile details for SMS auth
smsNumberTitle	string	Title for phone number details
smsCodeMessage	string	'Enter the confirmation code'
smsCodeFieldLabel	string	'Confirmation Code'
smsCodeSubmit	string	Label for confirmation code submit button
smsCodeCancel	string	Label for cancel confirmation code submission
smsCodeError	string	error message when confirmation code is invalid
smsHaveAccessCode	string	Label for checkbox to specify that the user has access code
smsValidityDuration	int	how long confirmation code should be considered valid (in minutes)
smsMessageFormat	string	format of access code sms message.'{{code}}'and'{{duration}}'are place holders and should be retained as is.
sponsorEmail	string	label for Sponsor Email
sponsorName	string	label for Sponsor Name
sponsorRequestAccess	string	submit button label request Wifi Access and notify sponsor about guest request
sponsorSubmit	string	submit button label to notify sponsor about guest request
sponsorStatusDenied	string	text to display when sponsor denies request
sponsorStatusApproved	string	text to display if sponsor approves request
sponsorStatusPending	string	text to display if request is still pending
sponsorEmailError	string	'Please provide valid sponsor email'
sponsorNameError	string	'Please provide sponsor's name'
sponsorBackLink	string	'Go back and edit request form'
sponsorCancel	string	'Cancel'
sponsorInfoApproved	string	'Your request was approved by'
sponsorInfoDenied	string	'Your request was denied by'
sponsorInfoPending	string	'Your notification has been sent to'
sponsorsInfoApproved	string	“Your request was approved”
sponsorsInfoDenied	string	“Your request was denied”
sponsorsInfoPending	string	“Your notification has been sent to the sponsors”
sponsorNotePending	string	'Please wait for them to acknowledge.'
sponsorSelectEmail	string	“Select Sponsor”
sponsorsError	string	“Please select a sponsor”
authButtonSponsor	string	label for Sponsor auth button
authButtonAmazon	string	label for Amazon auth button
authButtonAzure	string	label for Azure auth button
authButtonEmail	string	label for Email auth button
authButtonMicrosoft	string	label for Microsoft auth button
smsCarrierDefault	string	'Please Select'
smsCarrierError	string	'Please select a mobile carrier'
smsCodeTitle	string	'Access Code'
smsCountryFieldLabel	string	'Country Code'
smsCountryFormat	string	'+1'
smsNumberError	string	'Invalid Mobile Number'
smsNumberFormat	string	'2125551212 (digits only)'
smsNumberMessage	string	'We will send an access code to your mobile number which you can use to connect to the WiFi network. Message and data rates may apply.'
smsUsernameFormat	string	'username'
accessCodeAlternateEmail	string	'Use alternate email address'
emailMessage	string	'We will email you an authentication code which you can use to connect to the WiFi network.'
emailCodeError	string	'Please provide valid alternate email'
emailCancel	string	'Cancel'
emailFieldLabel	string	'Enter your email address'
emailTitle	string	'Sign in with Email'
emailSubmit	string	Label for confirmation code submit button using email auth
emailCodeCancel	string	Label for cancel confirmation code submission using email auth
emailCodeFieldLabel	string	“Confirmation Code”
emailCodeMessage	string	“Enter the access number that was sent to your email address.”
emailCodeSubmit	string	“Sign In”
emailCodeTitle	string	“Access Code”
authLabel	string	'Connect to WiFi with'
sponsorEmailTemplate	string	html template to replace/override default sponsor email template
privacyPolicy	boolean	default is false
privacyPolicyText	string	privacy notice text
privacyPolicyAcceptLabel	string	prefix of the label of the link to go to /privacy_notice,
privacyPolicyLink	string	label of the link to go to /privacy_notice,
privacyPolicyError	string	error message when privacy notice is not accepted”,

Sponsor Email Template supports following template variables:

Name	Description
approve_url	Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized
deny_url	Renders URL to reject the request
guest_email	Renders Email ID of the guest
guest_name	Renders Name of the guest
field1	Renders value of the Custom Field 1
field2	Renders value of the Custom Field 2
company	Renders value of the Company field
sponsorlinkvalidity_duration	Renders validity time of the request (i.e. Approve/Deny URL)
authexpireminutes	Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes)

HEADERS

Key	Datatype	Required	Description
`Accept`	string
`X-CSRFToken`	string
`Content-Type`	string

updateSiteWlanPortalTemplate

Body Parameters

Sponsor Email Template Parameters

HEADERS