---
title: "Get or create a booking link"
method: POST
path: "/v2/booking-links"
tags: ["Appointments.Booking Links"]
---

# Get or create a booking link

`POST /v2/booking-links`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/booking-links`
- Auth: API key in header `x-api-key`

Get a link a customer can use to book their own appointment on a booking calendar. If that customer already has a link for that calendar, you get the same link back. Links last until you revoke them, unless you set expiresAt.

## Request body

- PostV2BookingLinksRequestBody
  - `clientCustomerId` string, uuid, required
  - `appointmentConfigId` string, uuid, required
  - `expiresAt` string, date-time

## Response `200`

POST /v2/booking-links Positive response

- PostV2BookingLinksPositiveResponse
  - `code` string, required
  - `clientCustomerId` string, uuid, nullable, required
  - `appointmentConfigId` string, uuid, required
  - `expiresAt` unknown, required
  - `revokedAt` unknown, required
  - `createdAt` unknown, required
  - `url` string, required

## Other responses

- `400`: POST /v2/booking-links Negative response 400
- `401`: POST /v2/booking-links Negative response 401
- `403`: POST /v2/booking-links Negative response 403
- `404`: POST /v2/booking-links Negative response 404
- `409`: POST /v2/booking-links Negative response 409
- `422`: POST /v2/booking-links Negative response 422
- `429`: POST /v2/booking-links Negative response 429
- `500`: POST /v2/booking-links Negative response 500
- `502`: POST /v2/booking-links Negative response 502
- `503`: POST /v2/booking-links Negative response 503

---

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