SitesWlans
updateSiteWlanPortalTemplate
Update a Portal Template
Sponsor Email Template
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 |
| sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) |
| auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
site_id*string
Format
uuidwlan_id*string
Format
uuidRequest Body
application/json
Request Body
Guest portal template payload for a WLAN
portal_template?
Template settings that define guest portal text, layout, and localization
Response Body
curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wlans/000000ab-00ab-00ab-00ab-0000000000ab/portal_template" \ -H "Content-Type: application/json" \ -d '{ "portal_template": { "accessCodeAlternateEmail": "string", "alignment": "left", "authButtonAmazon": "string", "authButtonAzure": "string", "authButtonEmail": "string", "authButtonFacebook": "string", "authButtonGoogle": "string", "authButtonMicrosoft": "string", "authButtonPassphrase": "string", "authButtonSms": "string", "authButtonSponsor": "string", "authLabel": "string", "backLink": "string", "color": "string", "colorDark": "string", "colorLight": "string", "company": true, "companyError": "string", "companyLabel": "string", "email": true, "emailAccessDomainError": "string", "emailCancel": "string", "emailCodeError": "string", "emailError": "string", "emailFieldLabel": "string", "emailLabel": "string", "emailMessage": "string", "emailSubmit": "string", "emailTitle": "string", "field1": true, "field1Error": "string", "field1Label": "string", "field1Required": true, "field2": true, "field2Error": "string", "field2Label": "string", "field2Required": true, "field3": true, "field3Error": "string", "field3Label": "string", "field3Required": true, "field4": true, "field4Error": "string", "field4Label": "string", "field4Required": true, "message": "string", "name": true, "nameError": "string", "nameLabel": "string", "optout": true, "optoutLabel": "string", "pageTitle": "string", "passphraseCancel": "string", "passphraseError": "string", "passphraseLabel": "string", "passphraseMessage": "string", "passphraseSubmit": "string", "passphraseTitle": "string", "poweredBy": true, "requiredFieldLabel": "string", "signInLabel": "string", "smsCarrierDefault": "string", "smsCarrierError": "string", "smsCarrierFieldLabel": "string", "smsCodeCancel": "string", "smsCodeError": "string", "smsCodeFieldLabel": "string", "smsCodeMessage": "string", "smsCodeSubmit": "string", "smsCodeTitle": "string", "smsCountryFieldLabel": "string", "smsCountryFormat": "string", "smsHaveAccessCode": "string", "smsMessageFormat": "string", "smsNumberCancel": "string", "smsNumberError": "string", "smsNumberFieldLabel": "string", "smsNumberFormat": "string", "smsNumberMessage": "string", "smsNumberSubmit": "string", "smsNumberTitle": "string", "smsUsernameFormat": "string", "smsValidityDuration": 30, "sponsorBackLink": "string", "sponsorCancel": "string", "sponsorEmail": "string", "sponsorEmailError": "string", "sponsorEmailTemplate": "string", "sponsorInfoApproved": "string", "sponsorInfoDenied": "string", "sponsorInfoPending": "string", "sponsorName": "string", "sponsorNameError": "string", "sponsorNotePending": "string", "sponsorStatusApproved": "string", "sponsorStatusDenied": "string", "sponsorStatusPending": "string", "sponsorSubmit": "string", "sponsorsFieldLabel": "string", "tos": true, "tosAcceptLabel": "string", "tosError": "string", "tosLink": "string", "tosText": "string" } }'{ "portal_template": { "accessCodeAlternateEmail": "string", "alignment": "left", "authButtonAmazon": "string", "authButtonAzure": "string", "authButtonEmail": "string", "authButtonFacebook": "string", "authButtonGoogle": "string", "authButtonMicrosoft": "string", "authButtonPassphrase": "string", "authButtonSms": "string", "authButtonSponsor": "string", "authLabel": "string", "backLink": "string", "color": "string", "colorDark": "string", "colorLight": "string", "company": true, "companyError": "string", "companyLabel": "string", "email": true, "emailAccessDomainError": "string", "emailCancel": "string", "emailCodeError": "string", "emailError": "string", "emailFieldLabel": "string", "emailLabel": "string", "emailMessage": "string", "emailSubmit": "string", "emailTitle": "string", "field1": true, "field1Error": "string", "field1Label": "string", "field1Required": true, "field2": true, "field2Error": "string", "field2Label": "string", "field2Required": true, "field3": true, "field3Error": "string", "field3Label": "string", "field3Required": true, "field4": true, "field4Error": "string", "field4Label": "string", "field4Required": true, "message": "string", "name": true, "nameError": "string", "nameLabel": "string", "optout": true, "optoutLabel": "string", "pageTitle": "string", "passphraseCancel": "string", "passphraseError": "string", "passphraseLabel": "string", "passphraseMessage": "string", "passphraseSubmit": "string", "passphraseTitle": "string", "poweredBy": true, "requiredFieldLabel": "string", "signInLabel": "string", "smsCarrierDefault": "string", "smsCarrierError": "string", "smsCarrierFieldLabel": "string", "smsCodeCancel": "string", "smsCodeError": "string", "smsCodeFieldLabel": "string", "smsCodeMessage": "string", "smsCodeSubmit": "string", "smsCodeTitle": "string", "smsCountryFieldLabel": "string", "smsCountryFormat": "string", "smsHaveAccessCode": "string", "smsMessageFormat": "string", "smsNumberCancel": "string", "smsNumberError": "string", "smsNumberFieldLabel": "string", "smsNumberFormat": "string", "smsNumberMessage": "string", "smsNumberSubmit": "string", "smsNumberTitle": "string", "smsUsernameFormat": "string", "smsValidityDuration": 5, "sponsorBackLink": "string", "sponsorCancel": "string", "sponsorEmail": "string", "sponsorEmailError": "string", "sponsorEmailTemplate": "string", "sponsorInfoApproved": "string", "sponsorInfoDenied": "string", "sponsorInfoPending": "string", "sponsorName": "string", "sponsorNameError": "string", "sponsorNotePending": "string", "sponsorStatusApproved": "string", "sponsorStatusDenied": "string", "sponsorStatusPending": "string", "sponsorSubmit": "string", "tos": true, "tosAcceptLabel": "string", "tosError": "string", "tosLink": "string", "tosText": "string" }}