Update guest portal profile

put

https://{api-base-url}/guest/v1/portals/{portal_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

portal_id

string

required

Portal ID of the splash page

Body Params

portal data

name

string

required

Name of the portal (max length 22 characters)

auth_type

string

enum

Defaults to unauthenticated

Authentication type of portal

Allowed:

username_password_enabled

boolean

Defaults to false

Username/Password authentication type

registration_enabled

boolean

Defaults to false

Identify if guest user can register on the portal

verify_registration

boolean

Defaults to false

Identify if verification is required for guest registration

bypass_cna_policy

boolean

Defaults to false

Identify if CNA policy is to be bypassed

cna_policy

string

enum

Defaults to allow_always

Allowed:

register_accept_email

boolean

Defaults to false

Identify if guest registration is performed via e-mail

register_accept_phone

boolean

Defaults to true

Identify if guest registration is performed via phone

free_wifi_duration

integer

Free wifi allowed durations (0 to 59 minutes)

self_reg_account_unlimited

boolean

Defaults to true

Indicates if default registration account expiry is unlimited or not

self_reg_account_expire_days

integer

Specify the default registration account expiry in days, min 0 to max 180.

self_reg_account_expire_hours

integer

Specify default registration account expiry in hours, min 0 to max 23

self_reg_account_expire_minutes

integer

Specify default registration account expiry in minutes, min 0 to max 59

login_button_title

object

Customizable login button label (optional field, max 32 characters).

whitelist_urls

array of strings

List of urls to white list or allow access before portal login

whitelist_urls

sms_messages

object

Custom sms messages (optional). If not set, default messages will be sent during registration, password and verificaton of account.

auth_sources

array of objects

List of social auth app values. This could be empty array.

auth_sources

facebook_wifi_configure_url

object

Use URL to create or customize the facebook wifi page which has to have facebook_wifi_gateway_id as a query param. Admin has to configure the page inorder to get facebook wifi working

facebook_wifi_gateway_id

object

Gateway should be used with facebook_wifi_configure_url to configure facebook wifi portal. This is auto generated.

redirect_url

object

Redirect url on succesful login

auth_failure_message

object

Display message on authentication failure (max 4096 characters)

session_timeout

object

Wireless connection session expiry. Valid input is minimum of 2 minutes and maximum of 180 days

mac_caching_enabled

boolean

Defaults to false

Flag to indicate whether mac chacing enabled

is_shared

boolean

Defaults to false

Flag to indicate whether portal is shared

simultaneous_login_limit

integer

Simultaneous portal logins limit. Value of 0 indicates there is no limit

daily_usage_limit

string

enum

Defaults to nolimit

IO data allowed to be used in a day. Either by time or data usage

Allowed:

usage_time

object

This is required when daily_uage_limit is by time

usage_data

object

This is required when daily_uage_limit is by data

background_color

object

Background color of the portal. (Format '#XXXXXX', 6 hex characters)

button_color

object

Button color. (Format '#XXXXXX' , 6 hex characters)

header_fill_color

object

Header color of the portal. This field can could be null. (Format '#XXXXXX' , 6 hex characters)

page_font_color

object

Portal page font color. (Format '#XXXXXX ', 6 hex characters)

logo_name

string

Defaults to Logo.png

Name of logo file

logo

object

Logo image. This is in base64 data format

background_image_name

string

Defaults to Background.png

Name of image file used as background

background_image

object

Background image. This is in base64 data format

max_columns

integer

Layout

page_title

object

Page title of the portal

welcome_text

object

Welcome text to be displayed in the portal

terms_condition

object

Terms and condition text to be displayed in the portal

display_terms_checkbox

boolean

Defaults to false

Show/hide terms condition check box

display_term_options

string

enum

Defaults to internal

Inline or overlay display option. Internal indicates inline

Allowed:

ad_url

object

Advertisement url. This requires add image input

login_image_name

string

Defaults to Ad.png

Name of logo file

ad_image

object

Advertisement image. This is in base64 data format

is_config_associated

boolean

Defaults to false

Indicates whether any configuration is associated to the portal

capture_url

object

URL to be used in wlan configuration

override_common_name

string

Parameter to override the common name

override_common_name_enabled

boolean

Defaults to false

Flag indicating whether the common name should be overridden

Responses

200

Successful response

401

Unauthorized

413

Request-size limit exceeded

429

API rate limit exceeded

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request, Object already exists or Invalid Parameters

403Forbidden

404Not Found

500Internal Server Error