> ## 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.

# Replacing the host list

> Replaces the location's **external** host list with what you send. The
previous external set is deleted first, so this is a full sync rather
than a merge. An empty array clears the list.

**One upload per location per 24 hours.** A second call inside that
window answers `200` with `hosts_imported: 0` and changes nothing — it
does not report an error. Schedule it as a nightly job.




## OpenAPI

````yaml https://vizito.eu/openapi.yaml post /visitees/external/upload/{company_id}
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/external/upload/{company_id}:
    post:
      tags:
        - Hosts
      summary: Replacing the host list
      description: |
        Replaces the location's **external** host list with what you send. The
        previous external set is deleted first, so this is a full sync rather
        than a merge. An empty array clears the list.

        **One upload per location per 24 hours.** A second call inside that
        window answers `200` with `hosts_imported: 0` and changes nothing — it
        does not report an error. Schedule it as a nightly job.
      operationId: replaceHostList
      parameters:
        - $ref: '#/components/parameters/companyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    type: object
                    required:
                      - cn
                    properties:
                      cn:
                        type: string
                      mail:
                        type: string
                        format: email
                      mobile:
                        type: string
                      telephoneNumber:
                        type: string
      responses:
        '200':
          description: How many hosts were written.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: visitees.SUCCESS
                  hosts_imported:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    companyId:
      name: company_id
      in: path
      required: true
      description: The location.
      schema:
        $ref: '#/components/schemas/ObjectId'
  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
  schemas:
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
  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

- [Listing hosts](/api-reference/hosts/listing-hosts.md)
- [Listing hosts, paged](/api-reference/hosts/listing-hosts-paged.md)
- [Introduction](/index.md)
- [Keeping hosts in sync](/documentation/syncing-hosts.md)
- [Creating a host](/api-reference/hosts/creating-a-host.md)
