---
title: "Create group link"
method: POST
path: "/group_links"
tags: ["Group links"]
---

# Create group link

`POST /group_links`

## Request body

- object
  - `group_link` object, required
    - `email` string, email, nullable — The email to the person who should have access.
    - `group_id` integer, required — The group ID of the group link
    - `name` string, required — The name of the group link
    - `phone` string, nullable — The phone number of the person who should have access. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
    - `quick_response_code_type` 'online' | 'offline' | 'null', nullable — Will generate a QR code (optionally offline capable) that can be scanned with compatible Kisi readers. Will be sent as part of the access link email, if an email address is provided. Will never be sent as part of SMS.
    - `link_enabled` boolean — Will generate a link that can be used for access.
    - `valid_from` string, date-time, nullable
    - `valid_until` string, date-time, nullable

## Response `200`

OK

- object
  - `id` integer, required — The ID of the group link
  - `resource_type` 'GroupLink', required — The resource type of the group link
  - `name` string, required — The name of the group link
  - `email` string, email, nullable, required — The email to the person who should have access.
  - `phone` string, nullable, required — The phone number of the person who should have access. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.
  - `last_used_at` string, date-time, nullable, required — When the group link was last used.
  - `link_enabled` boolean, required — Will generate a link that can be used for access.
  - `quick_response_code_type` 'online' | 'offline' | 'null', nullable, required — Will generate a QR code (optionally offline capable) that can be scanned with compatible Kisi readers. Will be sent as part of the access link email, if an email address is provided. Will never be sent as part of SMS.
  - `valid_from` string, date-time, nullable, required
  - `valid_until` string, date-time, nullable, required
  - `created_at` string, date-time, required — When the group link was created
  - `updated_at` string, date-time, required — When the group link was updated
  - `group_id` integer, required — The group ID of the group link
  - `group` object, required — The group of the group link
    - `id` integer, required — The ID of the group
    - `resource_type` 'Group', required — The resource type of the group
    - `name` string, required — The name of the group
  - `created_by_type` 'null' | 'User' | 'MarketplaceInstallation', nullable, required — The created_by type of the group link
  - `created_by_id` integer, nullable, required — The created_by ID of the group link
  - `created_by` union — The created_by of the group link
    - 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 marketplace installation
      - `resource_type` 'MarketplaceInstallation', required — The resource type of the marketplace installation
  - `issued_by_id` integer, nullable, required — The issued_by ID of the group link
  - `issued_by` object — The issued_by of the group link
    - `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
  - `secret` string, nullable, required — The secret value used for authentication.
  - `quick_response_code_token` string, nullable, required — The quick response code token.
  - `quick_response_code_image` string, nullable, required — The quick response code token rendered as a Base64-encoded PNG image.

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