OrgsGuests

updateOrgGuestAuthorization

PUT
/api/v1/orgs/{org_id}/guests/{guest_mac}

Update the organization guest authorization record for a guest MAC address, including authorization state, duration, WLAN, and guest identity fields.

Authorization

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

org_id*string
Formatuuid
guest_mac*string
Match^[0-9a-fA-F]{12}$

Request Body

application/json

Guest authorization record at organization scope

authorized?boolean

Whether the guest is currently authorized

Defaulttrue
company?string

Optional company name provided by the guest during registration

email?string

Optional email address provided by the guest during registration

Formatemail
field1?string

Optional custom field 1 value provided by the user during registration

field2?string

Optional custom field 2 value provided by the user during registration

field3?string

Optional custom field 3 value provided by the user during registration

field4?string

Optional custom field 4 value provided by the user during registration

mac?string

Device MAC address captured during guest registration

minutes?integer

Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days)

Range0 <= value <= 259200
Default1440
name?string

Optional name provided by the guest during registration

wlan_id*string

Identifier of the WLAN used for the guest authorization

Formatuuid

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/guests/0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "company": "string",    "email": "user@example.com",    "mac": "string",    "minutes": 1440,    "name": "John Smith",    "wlan_id": "6748cfa6-4e12-11e6-9188-0242ac110007"  }'

{  "authorized": true,  "authorized_expiring_time": 0,  "authorized_time": 0,  "company": "string",  "email": "user@example.com",  "field1": "string",  "field2": "string",  "field3": "string",  "field4": "string",  "mac": "string",  "minutes": 0,  "name": "string"}