> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vizito.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Creating a host

> Adds a managed host. There is no duplicate check on `cn` — if your
directory is the source of truth, replace the whole list instead.




## OpenAPI

````yaml https://vizito.eu/openapi.yaml post /visitees
openapi: 3.1.0
info:
  title: Vizito API
  version: 1.0.0
  description: |
    Read and write your Vizito visitor data over HTTPS.

    Every endpoint takes and returns JSON, and is authenticated with an API key
    created by a global admin on the Integrations page of the Backoffice.

    Almost every endpoint names a **location** — `company_id` in the API. Your
    key is pinned to a set of locations; naming one outside that set is refused
    with `403`. Start at `GET /companiesList`, the one endpoint that needs no
    location id.
  contact:
    name: Vizito support
    email: support@vizito.eu
    url: https://vizito.eu
  termsOfService: https://vizito.eu/terms
servers:
  - url: https://api.vizito.eu/api
    description: Production
security:
  - apiKey: []
tags:
  - name: Locations
    description: The locations your credential covers, and their configuration.
  - name: Visitors
    description: The visits themselves — one visitor is one visit, not a person.
  - name: Registered visitors
    description: Expected visitors — pre-register, invite, and sign in on arrival.
  - name: Hosts
    description: The people who can be visited.
  - name: Visit types
    description: The sign-in flows, and the questions they ask.
  - name: Entry points
    description: The doors and desks within a location.
  - name: Agreements
    description: The documents visitors sign, and the signed PDFs that come out.
  - name: Devices
    description: The kiosks at a location.
  - name: Reporting
    description: Counters, graphs and exports.
  - name: Webhooks
    description: The endpoint Vizito calls when something happens.
paths:
  /visitees:
    post:
      tags:
        - Hosts
      summary: Creating a host
      description: |
        Adds a managed host. There is no duplicate check on `cn` — if your
        directory is the source of truth, replace the whole list instead.
      operationId: createHost
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - company_id
                - cn
              properties:
                company_id:
                  $ref: '#/components/schemas/ObjectId'
                cn:
                  type: string
                  description: |
                    Full name. Keep it identical to the `recipient` your other
                    integrations send — that string links a visit to this host.
                mail:
                  type: string
                  format: email
                mobile:
                  type: string
                telephoneNumber:
                  type: string
                sticky:
                  type: boolean
      responses:
        '200':
          description: The host that was created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Visitee added!
                  data:
                    $ref: '#/components/schemas/Host'
        '403':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
    Host:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        company_id:
          $ref: '#/components/schemas/ObjectId'
        cn:
          type: string
          description: Full name. A visit's `recipient` matches a host on it.
          example: Jane Doe
        mail:
          type: string
          format: email
          description: Stored lower-cased.
        mobile:
          type: string
          description: Used for SMS notifications.
        telephoneNumber:
          type: string
          description: Desk phone, shown to reception.
        sticky:
          type: boolean
          description: Pinned to the top of the kiosk list.
        external:
          type: boolean
          description: Pushed through the bulk host upload.
        create_date:
          type: string
          format: date-time
        mod_date:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: |
        The credential was refused, or the endpoint is off limits to API keys.
        Every refusal answers identically — see the Authentication page.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Invalid API key
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >
        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.

````

## Related topics

- [Creating a registered visitor](/api-reference/registered-visitors/creating-a-registered-visitor.md)
- [Creating an entry point](/api-reference/entry-points/creating-an-entry-point.md)
- [Authentication](/api-reference/authentication.md)
- [Fetching a host](/api-reference/hosts/fetching-a-host.md)
- [Deleting a host](/api-reference/hosts/deleting-a-host.md)
