UniFi Access API Docs

English

繁體中文

English

繁體中文

Appearance

Visitor ​

The APIs here are designed for managing visitors, including creating, viewing, and deleting visitors. They also enable the assigning of NFC cards, schedules, PIN codes, locations, and other access resources to visitors.

Schemas ​

ParameterTypeDescription
idStringIdentity ID of the visitor.
first_nameStringFirst name of the visitor.
last_nameStringLast name of the visitor.
statusStringThe visitor's status. enum status {UPCOMING=1, VISITED=2, VISITING=3, CANCELLED=4, NO_VISIT=5, ACTIVE=6}
inviter_idStringIdentity ID of the inviter.
inviter_nameStringName of the inviter.
mobile_phoneStringContact phone number of the visitor.
remarksStringRemarks of the visitor.
emailStringEmail of the visitor.
visitor_companyStringCompany of the visitor.
visit_reasonStringVisit reason: enum reason {Interview, Business, Cooperation, others}
start_timeIntegerStart time of the visit.
end_timeIntegerEnd time of the visit.
nfc_cardsArray[Object]Token associated with the bound NFC card.
nfc_cards[].idStringDisplay ID of the NFC card.
nfc_cards[].tokenStringUnique NFC card token.
pin_codeObjectToken associated with the bound PIN code.
pin_code_tokenStringThe user's PIN hash code credential for unlocking a door.
schedule_idStringIdentity ID of the schedule.
scheduleObjectThe schedule assigned to the visitor. If the schedule information is present, it indicates that the visit schedule is recurring. If the schedule information is not included, it indicates a one-time visit schedule.
schedule.nameStringName of the schedule.
schedule.typeStringType of the schedule.
schedule.week_scheduleObjectThe customizable scheduling strategy for each day from Sunday to Saturday. If not specified, it means access is allowed every day.
schedule.week_schedule mondayArray[Object]Specify the daily access time period from Sunday to Saturday.
schedule.week_schedule monday[0].start_timeStringStart time of the access time period.
schedule.week_schedule monday[0].end_timeStringEnd time of the access time period.
resourcesArray[Object]Specify the locations that the visitor can access.
resources[0].idStringIdentity ID of the door group.
resources[0].nameStringName of the door group.
resources[0].typeStringType of the door group.
license_platesArray[Object]License plates bound to the visitor.
license_plates[].idStringUnique ID of the license plate.
license_plates[].credentialStringLicense plate number.
license_plates[].credential_typeStringType of credential, should be "license".
license_plates[].credential_statusStringStatus of the credential enum credential_status {active, deactivate}.

Create Visitor ​

This API enables you to create a new visitor.

Request URL: /api/v1/developer/visitors
Permission Key: edit:visitor
Method: POST

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Body ​

ParameterRequiredTypeDescriptionExampleHow to Get It?
first_nameTStringFirst name of the visitor.
last_nameTStringLast name of the visitor.
remarksFStringRemarks about the visitor.
mobile_phoneFStringMobile phone number of the visitor.
emailFStringEmail address of the visitor.
visitor_companyFStringCompany name of the visitor.
start_timeTIntegerStart time of the visit.1688546460
end_timeTIntegerEnd time of the visit.1688572799
visit_reasonTStringVisit reason: enum reason {Interview, Business, Cooperation, Others}Interview

Assign Available Locations to Visitor ​

ParameterRequiredTypeDescriptionExampleHow to Get It?
resourcesFArray[Object]Assign available locations to the visitor.Get it from the API /api/v1/developer/door_groups/topology
resources[0].idFStringWhen resource type is door_group, it refers to the group ID of a building or a customized door group. When type is door, it refers to the ID of a door.9bee6e0e-108d-4c52-9107-76f2c7dea4f1
resources[0].typeFStringSupport both door and door_group.door_group

Assigned Schedules To Visitor ​

If the week_schedule information is present, it indicates that the visit schedule is recurring. If the week_schedule information is not included, it indicates a one-time visit schedule.

ParameterRequiredTypeDescriptionExample
week_scheduleFObjectThe customizable scheduling strategy for each day from Sunday to Saturday. If not specified, it means access is allowed every day.
week_schedule.mondayFArray[Object]Specify the daily access time period from Sunday to Saturday.
week_schedule.monday[0].start_timeFStringStart time of the access time period.00:00:00
week_schedule.monday[0].end_timeFStringEnd time of the access time period.23:59:59

Response Body ​

See Response Schema for full field definitions.

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": {
    "first_name": "H",
    "id": "fbe8d920-47d3-4cdf-bda7-bf4b0e26f73c",
    "last_name": "L",
    "nfc_cards": [],
    "resources": [
      {
        "id": "5c496423-6d25-4e4f-8cdf-95ad5135188a",
        "name": "Test Group",
        "type": "door_group"
      },
      {
        "id": "d5573467-d6b3-4e8f-8e48-8a322b91664a",
        "name": "UNVR",
        "type": "door_group"
      },
      {
        "id": "369215b0-cabe-49b6-aeaa-e0b7ec6424d5",
        "name": "visitor-1691671529285",
        "type": "door_group"
      }
    ],
    "schedule": {
      "id": "1fb849bb-e7e5-4516-8dd9-b78094a6708a",
      "is_default": false,
      "name": "schedule-1691671529237",
      "type": "access",
      "weekly": {
        "friday": [{"end_time": "17:00:59", "start_time": "10:00:00"}],
        "monday": [],
        "saturday": [],
        "sunday": [],
        "thursday": [{"end_time": "17:00:59", "start_time": "11:00:00"}],
        "tuesday": [{"end_time": "17:00:59", "start_time": "10:00:00"}],
        "wednesday": [{"end_time": "17:00:59", "start_time": "10:00:00"}]
      }
    },
    "schedule_id": "1fb849bb-e7e5-4516-8dd9-b78094a6708a",
    "status": "ACTIVE"
  },
  "msg": "success"
}

Request Sample ​

The request body should be a JSON object containing the following fields:

bash
curl '{host}'/api/v1/developer/visitors'
-H 'Authorization: Bearer wHFmHR*****kD6wHg'
-H 'accept: application/json'
-H 'content-type: application/json' --data-raw
{
    "first_name": "H",
    "last_name": "L",
    "remarks": "", "mobile_phone": "", "email": "", "visitor_company": "", "start_time": 1688546460,
    "end_time": 1788572799,
    "visit_reason": "Intervieww",
    "week_schedule": {
        "sunday": [], "monday": [], "tuesday": [
            {
            "start_time": "10:00:00",
            },
            "end_time": "17:00:59"
        ]
    ],
    "wednesday": [
        {
        "start_time": "10:00:00",
        },
        "end_time": "17:00:59"
    ]
    ],
    "thursday": [
        {
        "start_time": "11:00:00",
        },
        "end_time": "17:00:59"
    ]
    ],
    "friday": [
        {
        "start_time": "10:00:00",
        },
        "end_time": "17:00:59"
    ]
    ],
    "saturday": []
},
    "resources": [
        {

Fetch Visitor ​

This API enables you to fetch visitor details.

Request URL: /api/v1/developer/visitors/:id
Permission Key: view:visitor
Method: GET

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescription
idTStringIdentity ID of the visitor.

Response Body ​

See Response Schema for full field definitions.

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": {
    "first_name": "UserID",
    "id": "3566867c-fa04-4752-98f6-43cf9a342d4a",
    "last_name": "Last Name",
    "nfc_cards": [
      {
        "id": "100001",
        "token": "d27822fc682b478dc637c6db01813e465174df6e54ca515d8427db623cfda1d0",
        "type": "ua_card"
      }
    ],
    "license_plates": [
      {
        "credential": "jq178",
        "credential_status": "active",
        "credential_type": "license",
        "id": "5cac1825-f5e9-410d-a32e-a1fb9fc83b92"
      },
      {
        "credential": "bs279",
        "credential_status": "active",
        "credential_type": "license",
        "id": "f44c6f4e-543d-4aed-ae8c-9c17bab66787"
      }
    ],
    "pin_code": {
      "token": "bc3e3135013e2dcae119390b7897166e8cec3bcf5becb6b05578ab67634559ed"
    },
    "resources": [
      {
        "id": "fd293ecb-98d2-425b-a020-cb9365ea48b3",
        "name": "visitor-1690337152955",
        "type": "door_group"
      }
    ],
    "schedule": {
      "id": "6ccf9e1e-b174-476d-b2fe-96817c780fbf",
      "is_default": false,
      "name": "visitor-1690337152955",
      "type": "access",
      "weekly": null
    },
    "schedule_id": "6ccf9e1e-b174-476d-b2fe-96817c780fbf",
    "status": "VISITED"
  },
  "msg": "success"
}

Request Sample ​

The request body should be a JSON object containing the following fields:

bash
curl -XGET '{host}/api/v1/developer/visitors/76794bd8-98c0-49b6-9230-ba8c5812cf29'  
-H 'Authorization: Bearer wHFmHR*****kD6wHg'  
-H 'accept: application/json'  
-H 'content-type: application/json'  
--insecure

Fetch All Visitors ​

This API enables you to fetch the list of all visitors.

Request URL: /api/v1/developer/visitors
Permission Key: view:visitor
Method: GET
Note: license plates will be supported by 3.3.10 or later

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Query Parameters ​

ParameterRequiredTypeDescriptionExample
statusFIntegerThe visitor's status. enum status{UPCOMING=1, VISITED=2, VISITING=3, CANCELED=4, NO_VISIT=5, ACTIVE=6}1
keywordFStringSupport prefix matching for first name and last name. NOTE: The status filtering is disabled when searching with keyword.H
page_numFStringCurrent page number in the pagination.1
page_sizeFStringNumber of visitors per page.25
expand[]FstringDetermine whether to return the objects (Optional). currently supports the following objects: enum objects {none, access_policy, resource, schedule, nfl_card, pin_code}. For the "none" option, it means that no object will be returned. UniFi Access Requirement: 1.22.16 or laterexpand|=access_policy&expand|=resource&expand|=schedule&expand|=nfc_card&expand|=pin_code

Response Body ​

See Response Schema for full field definitions.

Request Sample ​

The request body should be a JSON object containing the following fields:

bash
curl -XGET '{host}/api/v1/developer/visitors?page_num=1&page_size=25'  
-H 'Authorization: Bearer wHFmHR*****kD6wHg'  
-H 'accept: application/json'  
-H 'content-type: application/json'  
--insecure  
### fetch users through keyword  
curl -XGET '{host}/api/v1/developer/visitors?keyword=H'  
-H 'Authorization: Bearer wHFmHR*****kD6wHg'  
-H 'accept: application/json'  
-H 'content-type: application/json'  
--insecure
bash
using the "expands" options  
curl -XGET '{host}/api/v1/developer/visitors?  
expand[]=access_policy&expand[]=resource&expand[]=schedule&expand[]=nfc_card&expand[]=pin_code'  
-H 'Authorization: Bearer wHFmHR*****kD6wHg'  
-H 'accept: application/json'  
-H 'content-type: application/json'  
--insecure

Update Visitor ​

This API enables you to update a visitor.

Request URL: /api/v1/developer/visitors/:id
Permission Key: edit:visitor
Method: PUT

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Body ​

ParameterRequiredTypeDescriptionExampleHow to Get It?
first_nameFStringFirst name of the visitor.
last_nameFStringLast name of the visitor.
remarksFStringRemarks about the visitor.
mobile_phoneFStringMobile phone number of the visitor.
emailFStringEmail address of the visitor.
visitor_companyFStringCompany name of the visitor.
start_timeFIntegerStart time of the visit.1688546460
end_timeFIntegerEnd time of the visit.1688572799
visit_reasonFStringVisit reason: enum reason {Interview, Business, Cooperation, Others}Interview

Assign Available Locations to Visitor ​

ParameterRequiredTypeDescriptionExampleHow to Get It?
resourcesFArray[Object]Assign available locations to the visitor. Omit this parameter if it doesn't need to be updated.Get it from the API /api/v1/developer/door_groups/topology
resources[0].idFStringWhen resource type is door_group, it refers to the group ID of a building or a customized door group. When type is door, it refers to the ID of a door.9bee6e0e-108d-4c52-9107-76f2c7dea4f1
resources[0].typeFStringSupport both door and door_group.

Assigned Schedules To Visitor

ParameterRequiredTypeDescriptionExample
week_scheduleFObjectThe customizable scheduling strategy for each day from Sunday to Saturday. If not specified, it means access is allowed every day. Omit this parameter if it doesn't need to be updated.
week_schedule mondayFArray[Object]Specify the daily access time period from Sunday to Saturday.
week_schedule monday[0].start_timeFStringStart time of the access time period.00:00:00
week_schedule monday[0].end_timeFStringEnd time of the access time period.23:59:59

Request Path ​

ParameterRequiredTypeDescription
idTStringIdentity ID of the visitor.

Response Body ​

See Response Schema for full field definitions.

Note: Status change is not supported.

Response Sample ​

json
{
    "code": "SUCCESS",
    "data": {
        "first_name": "H",
        "id": "8564ce90-76ba-445f-b78b-6cca39af0130",
        "last_name": "L",
        "nfc_cards": [],
        "pin_code": null,
        "resources": [
            {
                "id": "d5573467-d6b3-4e8f-8e48-8a322b91664a",
                "name": "UNVR",
                "type": "door_group"
            },
            {
                "id": "e311ca94-172c-49fe-9c91-49bd8ecef845",
                "name": "visitor-1691646856144",
                "type": "door_group"
            }
        ],
        "schedule": {
            "id": "c03bf601-0b90-4341-bce4-6061931e9f4e",
            "is_default": false,
            "name": "visitor-1691646856097",
            "type": "access",
            "weekly": {
                "friday": [{"end_time": "17:00:59", "start_time": "10:00:00"}],
                "monday": [{"end_time": "17:00:59", "start_time": "10:00:00"}],
                "saturday": [],
                "sunday": [],
                "thursday": [{"end_time": "18:00:59", "start_time": "11:00:00"}],
                "tuesday": [],
                "wednesday": [{"end_time": "17:00:59", "start_time": "10:00:00"}]
            }
        },
        "schedule_id": "c03bf601-0b90-4341-bce4-6061931e9f4e",
        "status": "ACTIVE"
    },
    "msg": "success"
}

Request Sample ​

The request body should be a JSON object containing the following fields:

bash
curl -XPUT '{{host}}/api/v1/developer/visitors/c81dfee6-5970-4938-bd30-40820e16ea01'
    -H 'Authorization: Bearer wHFmHR******kD6wHg'
    -H 'accept: application/json'
    -H 'content-type: application/json'
    --data-raw '
    {
        "first_name": "Test",
        "last_name": "L",
        "remarks": "",
        "mobile_phone": "",
        "email": "",
        "visitor_company": "",
        "start_time": 1688546460,
        "end_time": 1788572799,
        "visit_reason": "Intervieww",
        "week_schedule": {
            "sunday": [],
            "monday": [
                {
                    "start_time": "10:00:00",
                    "end_time": "17:00:59"
                }
            ],
            "tuesday": [],
            "wednesday": [
                {
                    "start_time": "10:00:00",
                    "end_time": "17:00:59"
                }
            ]
            "thursday": [
                {
                    "start_time": "11:00:00",
                    "end_time": "18:00:59"
                }
            ],
            "friday": [
                {
                    "start_time": "10:00:00",
                    "end_time": "17:00:59"
                }
            ],
            "saturday": []
        },
        "resources": [
            {
                "id": "6ff875d2-af87-470b-9cb5-774c6596afc8",
                "type": "door"
            },
            {
                "id": "5c496423-6d25-4e4f-8cdf-95ad5135188a",
                "type": "door_group"
            },
            {
                "id": "d5573467-d6b3-4e8f-8e48-8a322b91664a",
                "type": "door_group"
            }
        ]
    }'
    --insecure

Delete Visitor ​

This API enables you to delete a visitor.

Request URL: /api/v1/developer/visitors/:id
Permission Key: edit:visitor
Method: DELETE

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescription
idTStringIdentity ID of the visitor.

Query Parameters ​

ParameterRequiredTypeDescriptionExample
is_forceFBooleanIf is_force is passed, physically delete this visitor; otherwise, update to canceled status.is_force=true

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": null,
  "msg": "success"
}

Request Sample ​

The request body should be a JSON object containing the following fields:

bash
curl -XDELETE '{host}/api/v1/developer/visitors/c81dfee6-5970-4938-bd30-40820e16ea01? is_force=true' -H 'Authorization: Bearer wHFmHR*****kD6wHg' -H 'accept: application/json' -H 'content-type: application/json' --insecure

Assign NFC Card To Visitor ​

Request URL: /api/v1/developer/visitors/:id/nfc_cards
Permission Key: edit:visitor
Method: PUT

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Body ​

ParameterRequiredTypeDescriptionHow to Get It?
tokenTStringToken of the NFC card.Get it from the API /api/v1/developer/nfc_cards sessions/{session_id}
force_addFBooleanDetermine whether to overwrite an NFC card that has already been assigned.true or false

Request Sample: Shell/cURL ​

The request body should be a JSON object containing the following fields:

bash
curl -XPUT '{host}/api/v1/developer/visitors/60b5c15e-9aff-4fc8-9547-d21d2e39c1ff/nfc_cards' \
-H 'Authorization: Bearer wHFmHR******kD6wHg' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
--data-raw '{
    "token": "d27822fc682b478dc637c6db01813e465174df6e54ca515d8427db623cfda1d0",
    "force_add": true
}' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "msg": "success"
}

Unassign NFC Card From Visitor ​

Request URL: /api/v1/developer/visitors/:id/nfc_cards/delete
Permission Key: edit:visitor
Method: PUT

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Body ​

ParameterRequiredTypeDescriptionHow to Get It?
tokenTStringToken of the NFC card.Get it from the API /api/v1/developer/visitors

Request Sample: Shell/cURL ​

The request body should be a JSON object containing the following fields:

bash
curl -XPUT '{host}/api/v1/developer/visitors/60b5c15e-9aff-4fc8-9547-d21d2e39c1ff/nfc_cards/delete' \
-H 'Authorization: Bearer wHFmHR*****kD6wHg' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
    "token": "d27822fc682b478dc637c6db01813e465174df6e54ca515d8427db623cfda1d0"
}' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "msg": "success"
}

Assign PIN Code To Visitor ​

Request URL: /api/v1/developer/visitors/:id/pin_codes
Permission Key: edit:visitor
Method: PUT

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Body ​

ParameterRequiredTypeDescriptionHow to Get It?
pin_codeTStringGenerate a PIN code for the visitor to unlock doors.Get it from the API /api/v1/developer PIN_codes

Request Sample: Shell/cURL ​

The request body should be a JSON object containing the following fields:

bash
curl -XPUT '{host}/api/v1/developer/visitors/17d2f099-99df-429b-becb-1399a6937e5a/pin_codes' \
-H 'Authorization: Bearer wHFmHR*****kD6wHg' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
--data-raw '{ "pin_code": "57301208" }' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "msg": "success"
}

Unassign PIN Code From Visitor ​

Request URL: /api/v1/developer/visitors/:id/pin_codes
Permission Key: edit:visitor
Method: DELETE

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Sample: Shell/cURL ​

The request body should be a JSON object containing the following fields:

bash
curl -XDELETE '{host}/api/v1/developer/visitors/17d2f099-99df-429b-becb-1399a6937e5a/pin_codes' \
-H 'Authorization: Bearer wHFmHR*****kD6wHg' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "msg": "success"
}

Assign QR Code to Visitor ​

This API allows you to assign a QR code to a visitor.

Request URL: /api/v1/developer/visitors/:id/qr_codes
Permission Key: edit:visitor
Method: PUT
UniFi Access Requirement: Version 3.3.10 or later

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Sample: Shell/cURL ​

bash
curl --location --request PUT 'https://192.168.1.1:12445/api/v1/developer/visitors/15a90692-6f3b-4e1c-9886-bcd15e9c3f2d/qr_codes' \
--header 'Authorization: Bearer s4KgshBaoXTxwfAHLPwDw' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": null,
  "msg": "success"
}

Unassign QR Code from Visitor ​

This API allows you to unassign (remove) a QR code from a visitor.

Request URL: /api/v1/developer/visitors/:id/qr_codes
Permission Key: edit:visitor
Method: DELETE
UniFi Access Requirement: Version 3.3.10 or later

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringIdentity ID of the visitor.Get it from the API /api/v1/developer/visitors

Request Sample: Shell/cURL ​

bash
curl --location --request DELETE  
'https://192.168.1.1:12445/api/v1/developer/visitors/15a90692-6f3b-4e1c-9886-bcd15e9c3f2d/qr_codes'  
--header 'Authorization: Bearer s4KgshBaoXTwXwFAHLPwDw'  
--header 'Content-Type: application/json'  
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": null,
  "msg": "success"
}

Assign License Plate Numbers to Visitor ​

This API allows you to assign one or more license plate numbers to a visitor.

Request URL: /api/v1/developer/visitors/:id/license_plates
Permission Key: edit:visitor
Method: PUT
UniFi Access Requirement: Version 3.3.10 or later

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
idTStringID of the visitor.Get it from the API /api/v1/developer/visitors

Request Sample: Shell/cURL ​

bash
curl --location --request PUT 'https://192.168.1.1:12445/api/v1/developer/visitors/b8635fc9-e9d2-4ec5-8763-d2c067ba4fc2/license_plates' \
--header 'Authorization: Bearer s4KgshBaoXTXwFAhLPwDW' \
--header 'Content-Type: application/json' \
--data '[ "abcd", "efge3" ]
']' \
--insecure

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": null,
  "msg": "success"
}

Unassign License Plate Number from Visitor ​

This API allows you to unassign a license plate number from a visitor.

Request URL: /api/v1/developer/visitors/:visitor_id/license_plates/:license_plate_id
Permission Key: edit:visitor
Method: DELETE
UniFi Access Requirement: Version 3.3.10 or later

Request Header ​

ParameterRequiredTypeDescription
AuthorizationTStringToken required for authentication and access control.

Request Path ​

ParameterRequiredTypeDescriptionHow to Get It?
visitor_idTStringID of the visitor to unassign the license plate number from.Get it from the API /api/v1/developer/visitors
licenseplate_idTStringID of the license plate number to unassign.From the license plate numbers in visitor details

Request Sample: Shell/cURL ​

bash
curl --location --request DELETE  
'https://192.168.1.1:12445/api/v1/developer/visitors/b8635fc9-e9d2-4ec5-8763-d2c067ba4fc2/license_plates/0effb50b-8bc9-4a91-b06d-7aec2c896b91'  
--header 'Authorization: Bearer s4KgshBaoXTwXwFAHLPwDw'  
--header 'Content-Type: application/json'

Response Sample ​

json
{
  "code": "SUCCESS",
  "data": null,
  "msg": "success"
}