---
title: "Generate Guest portal links"
method: POST
path: "/api/connector/v1/reservations/generateGuestPortalLinks"
tags: ["Reservations"]
---

# Generate Guest portal links

`POST /api/connector/v1/reservations/generateGuestPortalLinks`

## Request

- Base URL: `https://api.mews.com`
- URL: `https://api.mews.com/api/connector/v1/reservations/generateGuestPortalLinks`
- Auth: none declared

Generates one or more Guest portal links for specific reservations and customers. These links can be used to grant guests direct access to their online check-in, key management, or other Guest portal functionalities. Links are single-use only. Reusing the same link multiple times may lead to a failed login attempt. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- MultipleGuestPortalLinkParameters
  - `ClientToken` string, required: Token identifying the client application.
  - `AccessToken` string, required: Access token of the client application.
  - `Client` string, required: Name and version of the client application.
  - `GuestPortalLinks` GuestPortalLinkParameters[], required: Collection of link parameters.
    - `ReservationId` string, uuid, required: ID of the reservation for which the link will be generated.
    - `CustomerId` string, uuid, required: ID of the customer for whom the link will be generated.
    - `GuestPortalLinkTypes` GuestPortalLinkTypeEnum[], required: Type of the link that will be generated.

## Response `200`

OK

- GuestPortalLinkResult
  - `GuestPortalLinks` GuestPortalLink[], required: Collection of requested links.
    - `ReservationId` string, uuid, required: ID of the reservation which is accessible through the link.
    - `CustomerId` string, uuid, required: ID of the customer whose Guest portal account is accessible through the link.
    - `GuestPortalUrls` GuestPortalUrlDetails[], required: Collection of URLs pointing to Guest portal.
      - `Url` string, required: URL granting access to Guest portal.
      - `GuestPortalLinkType` 'Homepage' | 'CheckIn' | 'CheckOut' | 'Chat' | 'Keys', required: Homepage (Link points to Guest portal home page.) CheckIn (Link points to online check-in flow.) CheckOut (Link points to online check-out flow.) Chat (Link points to messaging functionality.) Keys (Link points to a keys page (instructions, mobile, wallet).)
      - `ExpiresUtc` string, date-time, required: Expiration date and time of the link in UTC timezone in ISO 8601 format. After this time the link is invalidated and cannot be used to access Guest portal.

## Other responses

- `204`: Server has successfully fulfilled the request and there is no additional information to send back.
- `400`: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
- `401`: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403`: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
- `408`: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429`: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500`: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).

## Changes

- **2026-08-12** `66301d8e85af`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mews/apis/connector-api/changes/api/connector/v1/reservations/generateGuestPortalLinks/post.md)

---

[API](https://skmtc.dev/mews/apis/connector-api.md) - [All operations](https://skmtc.dev/mews/apis/connector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mews/apis/connector-api/revisions/cabf1b2da1d0?raw)