SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Appointments

POSThttps://app.softsolz.uk/api/v1/services/appointments/booking-links

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

titlestring

Heading shown on the booking page.

slugstring

The public booking address, so it is unique across SoftSolz. Leave it out to get one made from the title (a short suffix is added when that is taken). Sending one that is taken answers 409. Use it as data-booking-slug on the booking widget.

scopestring

tenant offers every bookable service, type offers one service (send type_id), resource books one person or room (send resource_id).

type_idinteger

The service to offer when scope is type.

resource_idinteger

The person or room to book when scope is resource.

configobject

Optional page settings.

Response

Response Body

idstringBooking link id. A whole number sent as a string.
tenant_idstringThe workspace this record belongs to.
kindstringAlways booking.
slugstringThe booking address. Use it as data-booking-slug on the booking widget.
scopestringtenant offers every bookable service, type offers one service, resource books one person or room.
type_idstring | nullService offered when scope is type. A whole number sent as a string, or null.
resource_idstring | nullPerson or room booked when scope is resource. A whole number sent as a string, or null.
titlestringHeading shown on the booking page.
configobjectBooking page settings. Only the settings you set are present.
is_activebooleanWhether the link takes bookings.
view_countintegerHow many times the booking page was opened.
last_used_atstring | nullWhen someone last booked through it.
created_atstringWhen the link was created.
updated_atstringWhen the link was last changed.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/appointments/booking-links \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Book a boiler service",
  "scope": "tenant"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "id": "632",
    "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61",
    "kind": "booking",
    "slug": "book-a-boiler-service",
    "scope": "type",
    "type_id": "934",
    "resource_id": null,
    "title": "Book a boiler service",
    "config": {
      "intro": "Pick a time that suits you.",
      "show_prices": true
    },
    "is_active": true,
    "view_count": 0,
    "last_used_at": null,
    "created_at": "2026-10-01T17:42:56.544Z",
    "updated_at": "2026-10-01T17:42:56.544Z"
  }
}