Skip to main content
POST
Creating a host

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"

cn
string
required

Full name. Keep it identical to the recipient your other integrations send — that string links a visit to this host.

mail
string<email>
mobile
string
telephoneNumber
string
sticky
boolean

Response

The host that was created.

message
string
Example:

"Visitee added!"

data
object