Custom Feature #649790

This document has been prepared for customer#1147 and covers the Smart WiFi Platform API functionality for interacting with Guest Profiles.

HTTP GET Example

Endpoint: /v2/client/guests/search? Description: Returns a list of hotspots associated with the client api token. Example: https://api.smartwifiplatform.com/v2/client/guests/search?api_token=52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86&email=example@gozonewifi.com Available Parameters: Example response:

[{"guest_token":"52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86","macaddress":"XX-XX-XX-XX-F8-7C","email":"example@gozonewifi.com","profile_url":null,"first_name":"Example","last_name":"Guest","country":null,"region":null,"city":null,"address":null,"gender":"male","postal_code":null,"birthdate":"1989-01-11","mobile_phone":"+15551234567","custom1":null,"custom2":null,"custom3":null,"custom4":null,"custom5":"no","custom6":null,"custom7":null,"custom1":"Custom 1","custom8":null,"custom9":null,"custom10":null,"unsubscribed":false}]

HTTP PUT Example

Endpoint: /v2/client/guests/update Description: This endpoint can be used to update the custom data fields of Guest Profile in the Smart WiFi platform. Example:

curl --location --request PUT 'https://api.smartwifiplatform.com/v2/client/guests/update' \ --header 'Content-Type: application/json' \ --data-raw '{  "api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",  "guest_token": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",  "custom5": "yes" }'

Available Parameters: