Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

Reservations & waitlist

Create a verified public booking intent and hold

POST/public/reservations/{publicHandle}/intents

Creates a short-lived capacity hold and sends contact verification under the public-channel policy. The intent must be verified before a reservation is committed. This bootstrap operation is intentionally public; the contact code protects conversion of the intent. A required Idempotency-Key makes retries with the same payload return the stored status and body; reusing the key with a different payload returns 409.

Authentication

A Hallify account session is not required. Follow this operation’s prerequisites and restrictions.

Connection guide

Parameters

publicHandlePath · Required

Opaque public channel handle used to resolve one venue’s published guest-facing configuration; it is not a credential.

string
Full definition
{
  "type": "string",
  "example": "example"
}
idempotency-keyHeader · Required

Required idempotency key, up to 128 characters

string
Full definition
{
  "type": "string",
  "minLength": 1,
  "maxLength": 128,
  "example": "example"
}
originHeader · Required

Browser Origin evaluated against the public channel allowlist; a missing or disallowed origin is rejected without exposing private venue configuration.

string
Full definition
{
  "type": "string",
  "example": "example"
}

Request body

Required

Creates a short-lived capacity hold and sends contact verification under the public-channel policy. The intent must be verified before a reservation is committed. This bootstrap operation is intentionally public; the contact code protects conversion of the intent.

application/json

PublicIntentDto
Full definition
{
  "$ref": "#/components/schemas/PublicIntentDto"
}

Responses

201Returns the verification intent, hold expiry, and redacted contact-delivery state.
ReservationPublicIntentDto
Full definition
{
  "$ref": "#/components/schemas/ReservationPublicIntentDto"
}
Example response · 201 · application/json
{
  "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
  "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
  "expiresAt": "2026-12-31T18:00:00.000Z"
}
409Idempotency key is already in progress or was reused with a different payload
IdempotencyConflictError
Full definition
{
  "$ref": "#/components/schemas/IdempotencyConflictError"
}
Example response · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
  "message": "errors:idempotency.inProgress",
  "translationKey": "errors:idempotency.inProgress"
}

Schemas

PublicIntentDto

Public reservation verification intent. The contact value is used only by the owning verification workflow and is not a capability token.

servicePeriodIdRequired

Hallify UUID identifying service period associated with public intent.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Hallify UUID identifying service period associated with public intent.",
  "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
}
scheduledAtRequired

RFC 3339 timestamp for scheduled at; offsets represent the same absolute instant.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "RFC 3339 timestamp for scheduled at; offsets represent the same absolute instant.",
  "example": "2026-01-15T12:00:00.000Z"
}
partySizeRequired

Whole-number party size recorded for public intent. Accepted values enforce minimum 1 and maximum 99.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "maximum": 99,
  "description": "Whole-number party size recorded for public intent. Accepted values enforce minimum 1 and maximum 99.",
  "example": 1
}
contactTypeRequired

Allowed contact type for public intent: EMAIL, PHONE.

string
Full definition
{
  "type": "string",
  "enum": [
    "EMAIL",
    "PHONE"
  ],
  "description": "Allowed contact type for public intent: EMAIL, PHONE.",
  "example": "EMAIL"
}
contactRequired

Contact for public intent. Accepted values enforce minimum length 3 and maximum length 254.

string
Full definition
{
  "type": "string",
  "minLength": 3,
  "maxLength": 254,
  "description": "Contact for public intent. Accepted values enforce minimum length 3 and maximum length 254.",
  "example": "example"
}
displayNameRequired

Human-readable display name for public intent. Accepted values enforce maximum length 120.

string
Full definition
{
  "type": "string",
  "maxLength": 120,
  "description": "Human-readable display name for public intent. Accepted values enforce maximum length 120.",
  "example": "Example name"
}
termsVersionRequired

Terms version for public intent. Accepted values enforce maximum length 64.

string
Full definition
{
  "type": "string",
  "maxLength": 64,
  "description": "Terms version for public intent. Accepted values enforce maximum length 64.",
  "example": "example"
}
privacyVersionRequired

Privacy version for public intent. Accepted values enforce maximum length 64.

string
Full definition
{
  "type": "string",
  "maxLength": 64,
  "description": "Privacy version for public intent. Accepted values enforce maximum length 64.",
  "example": "example"
}
guestRequestOptional

Guest request for public intent. Accepted values enforce maximum length 2000.

string
Full definition
{
  "type": "string",
  "maxLength": 2000,
  "description": "Guest request for public intent. Accepted values enforce maximum length 2000.",
  "example": "example"
}
Full definition
{
  "type": "object",
  "properties": {
    "servicePeriodId": {
      "type": "string",
      "format": "uuid",
      "description": "Hallify UUID identifying service period associated with public intent.",
      "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    },
    "scheduledAt": {
      "type": "string",
      "format": "date-time",
      "description": "RFC 3339 timestamp for scheduled at; offsets represent the same absolute instant.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 99,
      "description": "Whole-number party size recorded for public intent. Accepted values enforce minimum 1 and maximum 99.",
      "example": 1
    },
    "contactType": {
      "type": "string",
      "enum": [
        "EMAIL",
        "PHONE"
      ],
      "description": "Allowed contact type for public intent: EMAIL, PHONE.",
      "example": "EMAIL"
    },
    "contact": {
      "type": "string",
      "minLength": 3,
      "maxLength": 254,
      "description": "Contact for public intent. Accepted values enforce minimum length 3 and maximum length 254.",
      "example": "example"
    },
    "displayName": {
      "type": "string",
      "maxLength": 120,
      "description": "Human-readable display name for public intent. Accepted values enforce maximum length 120.",
      "example": "Example name"
    },
    "termsVersion": {
      "type": "string",
      "maxLength": 64,
      "description": "Terms version for public intent. Accepted values enforce maximum length 64.",
      "example": "example"
    },
    "privacyVersion": {
      "type": "string",
      "maxLength": 64,
      "description": "Privacy version for public intent. Accepted values enforce maximum length 64.",
      "example": "example"
    },
    "guestRequest": {
      "type": "string",
      "maxLength": 2000,
      "description": "Guest request for public intent. Accepted values enforce maximum length 2000.",
      "example": "example"
    }
  },
  "required": [
    "servicePeriodId",
    "scheduledAt",
    "partySize",
    "contactType",
    "contact",
    "displayName",
    "termsVersion",
    "privacyVersion"
  ],
  "description": "Public reservation verification intent. The contact value is used only by the owning verification workflow and is not a capability token.",
  "example": {
    "servicePeriodId": "81f8e4de-50f0-42ef-baa5-7f4b0580aa16",
    "scheduledAt": "2026-08-12T18:30:00.000Z",
    "partySize": 2,
    "contactType": "EMAIL",
    "contact": "guest@example.invalid",
    "displayName": "Example Guest",
    "termsVersion": "2026-08",
    "privacyVersion": "2026-08"
  }
}
ReservationPublicIntentDto

Pending guest verification for a booking or waitlist intent.

intentIdRequired

Booking intent identifier used for verification and resend.

string · uuid
Full definition
{
  "type": "string",
  "description": "Booking intent identifier used for verification and resend.",
  "format": "uuid",
  "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
}
verificationIdRequired

Guest identity verification identifier.

string · uuid
Full definition
{
  "type": "string",
  "description": "Guest identity verification identifier.",
  "format": "uuid",
  "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
}
expiresAtRequired

Expiry time of the pending booking intent.

string · date-time
Full definition
{
  "type": "string",
  "description": "Expiry time of the pending booking intent.",
  "format": "date-time",
  "example": "2026-12-31T18:00:00.000Z"
}
Full definition
{
  "type": "object",
  "description": "Pending guest verification for a booking or waitlist intent.",
  "required": [
    "intentId",
    "verificationId",
    "expiresAt"
  ],
  "properties": {
    "intentId": {
      "type": "string",
      "description": "Booking intent identifier used for verification and resend.",
      "format": "uuid",
      "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
    },
    "verificationId": {
      "type": "string",
      "description": "Guest identity verification identifier.",
      "format": "uuid",
      "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
    },
    "expiresAt": {
      "type": "string",
      "description": "Expiry time of the pending booking intent.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
    "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}
IdempotencyConflictError

Idempotency key is already in progress or was reused with a different payload.

Full definition
{
  "example": {
    "statusCode": 409,
    "error": "errors:http.conflict",
    "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
    "message": "errors:idempotency.inProgress",
    "translationKey": "errors:idempotency.inProgress"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/TranslatedErrorDto"
    },
    {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "statusCode": {
          "type": "integer",
          "enum": [
            409
          ],
          "description": "HTTP 409 conflict status.",
          "example": 409
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_REQUEST_NOT_READY",
            "IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
            "IDEMPOTENCY_REQUEST_IN_PROGRESS",
            "IDEMPOTENCY_SCOPE_INCOMPLETE"
          ],
          "description": "Allowed code for idempotency conflict error: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
          "example": "IDEMPOTENCY_REQUEST_NOT_READY"
        }
      },
      "example": {
        "code": "IDEMPOTENCY_REQUEST_NOT_READY"
      }
    }
  ],
  "description": "Idempotency key is already in progress or was reused with a different payload."
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full definition
{
  "type": "string",
  "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
  "example": "errors.request.invalid"
}
codeRequired

Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.

string
Full definition
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
}
translationKeyRequired

Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full definition
{
  "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full definition
{
  "description": "Optional domain-specific blocker or validation details",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code repeated from the response.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Optional domain-specific blocker or validation details",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Public field path. Nested properties and array indices are separated by dots."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.