Create Service Location

POST 
/calendars/services/locations

Create a new service location

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

namestringrequired

Location name

slugstringrequired

URL-friendly slug identifier

phonestring

Phone number

addressstring

Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.

coverImagestring

URL of the cover image for this service location

locationTypestring
Location type
Available optionsofflineask_booker

Example (auto)

{
  "locationId": "0007BWpSzSwfiuSl0tR2",
  "name": "Midtown Therapy Studio",
  "slug": "midtown-therapy-studio",
  "phone": "+1-212-555-0174",
  "address": "789 5th Avenue, Floor 3, New York, NY 10022 / Home Service",
  "coverImage": "https://storage.example.com/locations/midtown-therapy-studio/cover.jpg",
  "locationType": "offline"
}

application/json

Service location created successfully

application/json

Schema

Schema

idstringrequired

Service Location ID

locationIdstringrequired

Location ID

namestringrequired

Location name

slugstringrequired

Unique URL-friendly identifier for the service location

isActiveboolean
Whether location is active
Default value: true
isPrivateboolean
Whether location is private (not shown publicly)
Default value: false
coverImagestring

URL of the cover image displayed for this location

locationTypestring
Location type
Available optionsofflineask_booker
addressstring

Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.

phonestring

Contact phone number for the service location

Example (auto)

{
  "id": "65e5f6dfacf123513228d384",
  "locationId": "0007BWpSzSwfiuSl0tR2",
  "name": "Downtown Wellness Center",
  "slug": "downtown-wellness-center",
  "isActive": true,
  "isPrivate": false,
  "coverImage": "https://storage.example.com/locations/downtown-wellness-center/cover.jpg",
  "locationType": "offline",
  "address": "456 Market Street, Suite 200, San Francisco, CA 94105",
  "phone": "+1-415-555-0198"
}