HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Update some fields of a guest account

Update some fields of a guest account

Path Params
string
required

Numeric ID of the guest account

Query Params
string

true: Updates the network state using Disconnect-Request or CoA-Request, depending on the changes made
false: No action is taken
blank or unset: Use the default setting from Configuration » Authentication » Dynamic Authorization

Body Params
date-time

Time at which the account was created

int64

Action to take when the expire_time is reached

string

Email address for the account

boolean

Flag indicating if the account is enabled

date-time

Time at which the account will expire

int64

Numeric ID of the guest account (cannot be changed)

string

MAC address of the guest’s device

string

Comments or notes stored with the account

string

Password for the account

int64

Role to assign to the account

int64

Number of simultaneous sessions allowed for the account

string

Email address of the sponsor

string

Name of the sponsor of the account

string

Profile of the sponsor of the account

date-time

Time at which the account will be enabled

string

Username of the account

string

The guest’s company name

string

The guest’s full name

string

The guest’s contact telephone number

string

Additional properties (custom fields) may be stored with the account

Responses

Language
Response
Choose an example:
application/json