Group Bookings & Perks

Once a circle has its hotels, rooms, and allocations in place, the group can turn the plan into a booking and redeem pooled perks against it. Both endpoints authenticate as the end user with a Bearer JWT plus the X-App-Id and X-Environment headers. {circle_id} is the circle's UUID.

Initiate a Group Booking

POST /v1/circle/{circle_id}/bookings/initiate

Kicks off a group booking for the circle, using the hotels, rooms, and allocations already configured on it. The circle is identified entirely by the path — this endpoint takes no request body.

curl -X POST 'https://cloud.vanitypass.com/v1/circle/{circle_id}/bookings/initiate' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \

Redeem a Circle Perk

POST /v1/circles/{circle_id}/perks/redeem

Redeems a pooled circle (group) perk against the circle's booking.

Note: this is the one endpoint in the Circles surface whose path is pluralized — /v1/circles/... rather than /v1/circle/.... Use the plural form exactly as shown.

The endpoint accepts a JSON request body, but the spec does not define its fields — treat the payload as open and coordinate the exact shape with your integration contact before relying on it.

curl -X POST 'https://cloud.vanitypass.com/v1/circles/{circle_id}/perks/redeem' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \
  -d '{}'