Introduction

Core resources

Attribute options
Attributes
Booking details
Booking updates
Bookings
Calendar event notes
Calendar event tasks
Calendar event updates
Calendar events
Contact bookings
Contacts
Coupon products
Coupon services
Coupon uses
Coupons
Email events
Email templates
Emails
External calendars
Invoices
Line item taxes
Line items
Members
Occupancy group dependencies
Occupancy groups
Payments
Permissions
Product attribute options
Product calendar logs
Product configurations
Product email templates
Product occupancies
Product reply to addresses
Product services
Product tasks
Products
Reply to addresses
Seasons
Service deposit moments
Service discounts
Service payment moments
Service taxes
Services
Site listings
Site nav items
Site pages
Site views
Sites
Taxes
User profiles
Webhook notifications
Webhooks
Widget listings
Widget views
Widgets

Administration

Invite member
Revoke member
Create product
Delete product

Booking flow

Query availability
Search availability
Book

Attributes

Attributes to segment and filter units by

Endpoints
GET/attributesPOST/attributesDELETE/attributesPATCH/attributes

The attribute object

Attributes

iduuid

Unique identifier

organization_iduuid

Identifier of the organization this attribute is defined in

created_attimestamp with time zone

Creation timestamp

namejsonb

Localized name

orderinteger

Order of the attribute displayed on widgets and websites

type"single-select" | "multi-select"

Attribute type, either single-select of multi-select

The attribute object
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-05-12T11:06:16.165Z",
"name": {},
"order": 1,
"type": "single-select"
}

List attributes

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this attribute is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

nameFilter<jsonb>

Localized name

orderFilter<integer>

Order of the attribute displayed on widgets and websites

typeFilter<"single-select" | "multi-select">

Attribute type, either single-select of multi-select

Responses

200

A list of attributes with the selected columns

206

Partial Content

GET/attributes
curl -X GET "https://api.bookingmood.com/v1/attributes?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create attributes

Body

Partial<Attribute>
| Array<Partial<Attribute>>

Responses

201

The newly created attributes with the selected columns

POST/attributes
curl -X POST "https://api.bookingmood.com/v1/attributes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete attributes

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this attribute is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

nameFilter<jsonb>

Localized name

orderFilter<integer>

Order of the attribute displayed on widgets and websites

typeFilter<"single-select" | "multi-select">

Attribute type, either single-select of multi-select

Responses

204

The deleted attributes with the selected columns

DELETE/attributes
curl -X DELETE "https://api.bookingmood.com/v1/attributes" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update attributes

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this attribute is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

nameFilter<jsonb>

Localized name

orderFilter<integer>

Order of the attribute displayed on widgets and websites

typeFilter<"single-select" | "multi-select">

Attribute type, either single-select of multi-select

Body

Partial<Attribute>

Responses

204

The updated attributes with the selected columns

PATCH/attributes
curl -X PATCH "https://api.bookingmood.com/v1/attributes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'