Create Service

post

https://{api_url}/api/v5/admin/{company_id}/services

Creates a new bookable service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

int32

required

Body Params

Create Service

name

string

required

Name

reference

string

Reference

resource_ids

array of int32s

List of all resource IDs used to provide the service

resource_ids

person_ids

array of int32s

List of all people IDs who provides the service

person_ids

duration

int32

enum

Defaults to 60

Duration

spaces

int32

Defaults to 1

disabled

boolean

rules_group_id

int32

group_id

int32

order

int32

category_id

int32

Category ID

schedule_id

int32

Schedule ID

description

string

Description

max_advance_applies

string

enum

Defaults to all_customers

Maximum Advance Applies To

Allowed:

max_advance

string

Defaults to P60D

Maximum Advance

min_advance_applies

string

enum

Defaults to all_customers

Minimum Advance Applies To

Allowed:

min_advance

string

Defaults to P0D

Minimum Advance

min_cancel_applies

string

enum

Defaults to all_customers

Minimum Cancel Applies To

Allowed:

min_cancel

string

Defaults to P1D

Minimum Cancel

disable_before_date

date

Disable Before Date

disable_after_date

date

Disable After Date

min_length

int32

1 to 20

Defaults to 1

Minimum Length

max_length

int32

1 to 20

Defaults to 1

Maximum Length

question_group_id

int32

Question Group ID

pre_time

int32

enum

Defaults to 0

Default Pre-Time

post_time

int32

enum

Defaults to 0

Default Post-Time

booking_time_step

int32

Booking Time Step

listed_duration

int32

Listed Duration

service_type

string

enum

Service Type

Allowed:

method_of_appointment

string

enum

Service method of appointmnet

Allowed:

company_ids

array of int32s

List of child company ids

company_ids

booking_type

int32

Defaults to 3

Non-Members Booking

mbooking_type

int32

Defaults to 5

Members Booking

queue_duration

int32

A custom duration for the service when offered via the queue

queuing_disabled

boolean

States whether the service can be used for queuing

price

float

Price

price_after

float

Set a price which only takes effect at future date

price_after_date

date

Set a date in future in which the price changes

combine_resource_and_staff

boolean

Automatically assign staff and resource when the customer makes a booking

fixed_start_times

boolean

Fixed start times

confirmable_by

int32

enum

Customer Confirmable

Allowed:

fairness_strategy

string

enum

Fairness Strategy

Allowed:

service_booking_types

object

visibility_type

string

enum

Defaults to public

Visibility Type

Allowed:

configured_durations

array of objects

configured_durations

real_time_dashboard_config

object

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Service