Add People to Approved Lists

patch

https://{region}.verkada.com/v2/guest/approved_lists/add

Adds one or more people to one or more approved lists. This operation is idempotent - calling it multiple times with the same data won't create duplicates. People are matched by external_id first, then by email if no external_id is provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

people

array of objects

required

length between 1 and 100

List of people to add to approved lists.

People*

address

string

The person's street address.

approved_list_ids

array of strings

required

length between 1 and 10

List of one or more approved list IDs to add the person to.

Approved List Ids*

date_of_birth

string

The person's date of birth in YYYY-MM-DD format.

string

required

The person's email address.

expiration_timestamp

string

ISO 8601 formatted expiration time for the approved list entry. This will be shared by all entries corresponding to this person.

external_id

string

Stable external identifier. This can be used to ensure that changes are to the same person as well as ease syncing with an external system. Must be unique to the person within the organization if used.

full_name

string

required

The person's full name.

phone_number

string

The person's phone number.

Response

Language

Credentials

URL

Loading…

Response

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

application/json

200OK