Skip to main content
POST
Deleting registered visitors in bulk

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.

Path Parameters

company_id
string
required

The location. A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

Body

application/json

A 24-character hexadecimal id.

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

Response

One result per id.

id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

status
enum<string>
Available options:
success,
skipped,
error
reason
string

Why it was skipped, or what went wrong.

message
string