Skip to main content
POST
Creating a registered visitor

Authorizations

Authorization
string
header
required

An API key issued in the Backoffice, sent as Authorization: Bearer vzk_<key id>_<secret>. A Microsoft Entra ID access token obtained with the client credentials grant is accepted on the same header. The same value is also accepted in an X-API-Key header.

Body

application/json
company_id
string
required

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

visit_type
string

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

first_name
string
last_name
string
company
string
email
string<email>

Required if you want to invite them.

phone
string
recipient
string
visiting_on
object

When a visit is expected. Absent means "any day".

persistent
boolean
default:false
language
string

Response

The record that was created.

message
string
Example:

"Known Visitor added!"

data
object

An expected visitor. Custom fields defined by the visit type are stored here too, under their own field_name, and carried onto the visit.