---
title: "Create invite"
method: POST
path: "/invites"
tags: ["Invites"]
---

# Create invite

`POST /invites`

## Request body

- union
  - object
    - `invite` object, required
      - `notify` boolean — Whether to notify the invitee
      - `invites_to_type` 'Place', required
      - `invites_to_id` integer, required — The ID of the place
      - `invitee` union, required — The resource invited
        - object
          - `resource_type` 'User', required — The resource type of the user
          - `email` string, email, required — The email of the user.
          - `name` string, required — The name of the user
        - object
          - `resource_type` 'Guest', required — The resource type of the guest
          - `name` string, required — The name of the guest
          - `email` string, email, nullable, required — The email of the guest.
          - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
      - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
        - `link_enabled` boolean — Will generate a link that can be used for access.
        - `qr_code_enabled` boolean — Will generate a QR code that can be used for access.
      - `role_assignment` object, required
        - `role_id` string — The role ID of the role assignment.
  - object
    - `invite` object, required
      - `notify` boolean — Whether to notify the invitee
      - `invites_to_type` 'Group', required
      - `invites_to_id` integer, required — The ID of the group
      - `invitee` union, required — The resource invited
        - object
          - `resource_type` 'User', required — The resource type of the user
          - `email` string, email, required — The email of the user.
          - `name` string, required — The name of the user
        - object
          - `resource_type` 'Guest', required — The resource type of the guest
          - `name` string, required — The name of the guest
          - `email` string, email, nullable, required — The email of the guest.
          - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
      - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
        - `link_enabled` boolean — Will generate a link that can be used for access.
        - `qr_code_enabled` boolean — Will generate a QR code that can be used for access.
      - `role_assignment` object, required
        - `role_id` string — The role ID of the role assignment.
        - `valid_from` string, date-time, nullable — When the role assignment starts to be valid.
        - `valid_until` string, date-time, nullable — When the role assignment stops to be valid.
  - object
    - `invite` object, required
      - `notify` boolean — Whether to notify the invitee
      - `invites_to_type` 'Team', required
      - `invites_to_id` integer, required — The ID of the team
      - `invitee` union, required — The resource invited
        - object
          - `resource_type` 'User', required — The resource type of the user
          - `email` string, email, required — The email of the user.
          - `name` string, required — The name of the user
        - object
          - `resource_type` 'Guest', required — The resource type of the guest
          - `name` string, required — The name of the guest
          - `email` string, email, nullable, required — The email of the guest.
          - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
      - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
        - `link_enabled` boolean — Will generate a link that can be used for access.
        - `qr_code_enabled` boolean — Will generate a QR code that can be used for access.

## Response `200`

OK

- union
  - object
    - `id` integer, required — The ID of the invite
    - `resource_type` 'Invite', required — The resource type of the invite
    - `notify` boolean, required — Whether to notify the invitee
    - `created_at` string, date-time, required — When the invite was created
    - `updated_at` string, date-time, required — When the invite was updated
    - `invites_to_type` 'Place', required
    - `invites_to_id` integer, required — The ID of the place
    - `invitee_type` 'User' | 'Guest', required — The invitee type of the invite
    - `invitee_id` integer, required — The invitee ID of the invite
    - `invitee` union, required — The invitee of the invite
      - object
        - `id` integer, required — The ID of the user
        - `resource_type` 'User', required — The resource type of the user
        - `email` string, email, required — The email of the user.
        - `name` string, required — The name of the user
      - object
        - `id` integer, required — The ID of the guest
        - `resource_type` 'Guest', required — The resource type of the guest
        - `name` string, required — The name of the guest
        - `email` string, email, nullable, required — The email of the guest.
        - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
    - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
      - `id` integer, required — The ID of the access key
      - `resource_type` 'AccessKey', required — The resource type of the access key
      - `link_enabled` boolean, required — Will generate a link that can be used for access.
      - `qr_code_enabled` boolean, required — Will generate a QR code that can be used for access.
    - `role_assignment_id` integer, required — The role_assignment ID of the invite
    - `role_assignment` object, required — The role_assignment of the invite
      - `id` integer, required — The ID of the role assignment
      - `resource_type` 'RoleAssignment', required — The resource type of the role assignment
      - `role_id` string, required — The role ID of the role assignment.
  - object
    - `id` integer, required — The ID of the invite
    - `resource_type` 'Invite', required — The resource type of the invite
    - `notify` boolean, required — Whether to notify the invitee
    - `created_at` string, date-time, required — When the invite was created
    - `updated_at` string, date-time, required — When the invite was updated
    - `invites_to_type` 'Group', required
    - `invites_to_id` integer, required — The ID of the group
    - `invitee_type` 'User' | 'Guest', required — The invitee type of the invite
    - `invitee_id` integer, required — The invitee ID of the invite
    - `invitee` union, required — The invitee of the invite
      - object
        - `id` integer, required — The ID of the user
        - `resource_type` 'User', required — The resource type of the user
        - `email` string, email, required — The email of the user.
        - `name` string, required — The name of the user
      - object
        - `id` integer, required — The ID of the guest
        - `resource_type` 'Guest', required — The resource type of the guest
        - `name` string, required — The name of the guest
        - `email` string, email, nullable, required — The email of the guest.
        - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
    - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
      - `id` integer, required — The ID of the access key
      - `resource_type` 'AccessKey', required — The resource type of the access key
      - `link_enabled` boolean, required — Will generate a link that can be used for access.
      - `qr_code_enabled` boolean, required — Will generate a QR code that can be used for access.
    - `role_assignment_id` integer, required — The role_assignment ID of the invite
    - `role_assignment` object, required — The role_assignment of the invite
      - `id` integer, required — The ID of the role assignment
      - `resource_type` 'RoleAssignment', required — The resource type of the role assignment
      - `role_id` string, required — The role ID of the role assignment.
      - `valid_from` string, date-time, nullable, required — When the role assignment starts to be valid.
      - `valid_until` string, date-time, nullable, required — When the role assignment stops to be valid.
  - object
    - `id` integer, required — The ID of the invite
    - `resource_type` 'Invite', required — The resource type of the invite
    - `notify` boolean, required — Whether to notify the invitee
    - `created_at` string, date-time, required — When the invite was created
    - `updated_at` string, date-time, required — When the invite was updated
    - `invites_to_type` 'Team', required
    - `invites_to_id` integer, required — The ID of the team
    - `invitee_type` 'User' | 'Guest', required — The invitee type of the invite
    - `invitee_id` integer, required — The invitee ID of the invite
    - `invitee` union, required — The invitee of the invite
      - object
        - `id` integer, required — The ID of the user
        - `resource_type` 'User', required — The resource type of the user
        - `email` string, email, required — The email of the user.
        - `name` string, required — The name of the user
      - object
        - `id` integer, required — The ID of the guest
        - `resource_type` 'Guest', required — The resource type of the guest
        - `name` string, required — The name of the guest
        - `email` string, email, nullable, required — The email of the guest.
        - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
    - `access_key` object — Access key for the invitee. Only to be used when invitee is a guest.
      - `id` integer, required — The ID of the access key
      - `resource_type` 'AccessKey', required — The resource type of the access key
      - `link_enabled` boolean, required — Will generate a link that can be used for access.
      - `qr_code_enabled` boolean, required — Will generate a QR code that can be used for access.
    - `team_membership_id` integer, required — The ID of the team membership

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Content

---

[API](https://skmtc.dev/kisi/apis/kisi-api.md) · [All operations](https://skmtc.dev/kisi/apis/kisi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kisi/kisi-api/revisions/998700ffff5a/schema)