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

# Sending an invitation

> Sends the invitation email: the QR code that signs them in on arrival,
the calendar item, the wallet pass and the pre-registration link —
whichever the visit type is configured to include.

Send the object you got back when you created the record. `_id` is
required: the QR code and the pre-registration link are derived from it,
so an invitation for an id that does not exist produces a mail whose QR
code signs nobody in.

Locations on a trial are capped at 10 invitations.




## OpenAPI

````yaml https://vizito.eu/openapi.yaml post /knownvisitors/sendinvite/{language_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:
  /knownvisitors/sendinvite/{language_id}:
    post:
      tags:
        - Registered visitors
      summary: Sending an invitation
      description: |
        Sends the invitation email: the QR code that signs them in on arrival,
        the calendar item, the wallet pass and the pre-registration link —
        whichever the visit type is configured to include.

        Send the object you got back when you created the record. `_id` is
        required: the QR code and the pre-registration link are derived from it,
        so an invitation for an id that does not exist produces a mail whose QR
        code signs nobody in.

        Locations on a trial are capped at 10 invitations.
      operationId: sendInvitation
      parameters:
        - name: language_id
          in: path
          required: true
          description: 'Language of the email: `en`, `nl`, `fr`, `de`, … Falls back to `en`.'
          schema:
            type: string
            example: en
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
                - _id
                - company_id
                - email
              properties:
                _id:
                  $ref: '#/components/schemas/ObjectId'
                company_id:
                  $ref: '#/components/schemas/ObjectId'
                email:
                  type: string
                  format: email
      responses:
        '200':
          description: The invitation was queued. Empty body.
        '400':
          description: Too many invitations sent on a trial location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '403':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
    Message:
      type: object
      properties:
        message:
          type: string
  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

- [Sending invitations in bulk](/api-reference/registered-visitors/sending-invitations-in-bulk.md)
- [Pre-registering visitors](/documentation/pre-registering-visitors.md)
- [Updating a registered visitor](/api-reference/registered-visitors/updating-a-registered-visitor.md)
- [Updating a host](/api-reference/hosts/updating-a-host.md)
- [Updating a visit](/api-reference/visitors/updating-a-visit.md)