Create Service

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

Creates a new bookable service.

Path Params

company_id

int32

required

Body Params

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

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

Defaults to all_customers

Maximum Advance Applies To

max_advance

string

Defaults to P60D

Maximum Advance

min_advance_applies

string

Defaults to all_customers

Minimum Advance Applies To

min_advance

string

Defaults to P0D

Minimum Advance

min_cancel_applies

string

Defaults to all_customers

Minimum Cancel Applies To

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

Defaults to 0

Default Pre-Time

post_time

int32

Defaults to 0

Default Post-Time

booking_time_step

int32

Booking Time Step

listed_duration

int32

Listed Duration

service_type

string

Service Type

method_of_appointment

string

Service method of appointmnet

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

Customer Confirmable

fairness_strategy

string

Fairness Strategy

service_booking_types

object

visibility_type

string

Defaults to public

Visibility Type

configured_durations

array of objects

configured_durations

Response

Response body

object

integer

category_id

string

name

string

description

string

durations

array of integers

durations

prices

array of integers

prices

detail_group_id

string

color

string

listed_durations

array of integers

listed_durations

extra

object

booking_time_step

string

can_refund_automatically

boolean

is_event_group

boolean

api_ref

string

reference

string

type

string

group_id

integer

deleted

boolean

queuing_disabled

string

queue_duration

integer

company_id

integer

duration_unit

string

min_advance_period

integer

max_advance_period

integer

min_cancel_period

integer

booking_type_public

string

booking_type_member

string

booking_type

integer

mbooking_type

integer

min_length

string

max_length

string

method_of_appointment

string

groups

array of integers

groups

spaces

integer

order

integer

child_level_service

boolean

_embedded

object

company

object

          Create a child company given a parent company.
          <ol>
          <li> Services and Events get automatically copied down from the parent.
          <li> Settings are copied down from the parent.
          <li> People are not manually re-assigned, you can manually assign people to the new child company.
          <li> Resources are not copied down, you can re-create the resources at the new child company.
          <li> Timezone is assigned as the parent company's timezone, unless specified otherwise.
          </ol>
          You need to be logged in as an owner of the parent company to create a branch.

images

array of objects

images

object

string

company_id

string

name

string

image_file_name

string

foreign_key

string

url

string

membership_prices

object

global_id

integer

availability

integer

price

integer

price_after

integer

price_after_date

string

price_in_major_units

number

price_after_in_major_units

number

prices_in_major_units

array of numbers

prices_in_major_units

combine_resource_and_staff

string

visibility_type

string

disabled

string

client_queue_id

string

pre_time

string

post_time

string

rules_group_id

string

max_advance_applies

string

max_advance

string

min_advance_applies

string

min_advance

string

min_cancel_applies

string

min_cancel

string

fairness_strategy

string

listed_duration

string

question_group_id

string

duration

string

configured_durations

string

disable_before_date

string

disable_after_date

string

service_type

string

person_ids

string

resource_ids

string

read_only

string

copy_to_children_status

string

update_children_status

string

confirmable_by

string

multi_location_bookings

boolean

required_assets

string

fixed_start_times

string

service_booking_types

string

Language

Credentials

URL


xxxxxxxxxx
23
1
curl --request POST \
2
     --url https://example.jrni.com/api/v5/admin/company_id/services \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "duration": 60,
8
  "spaces": 1,
9
  "max_advance_applies": "all_customers",
10
  "max_advance": "P60D",
11
  "min_advance_applies": "all_customers",
12
  "min_advance": "P0D",
13
  "min_cancel_applies": "all_customers",
14
  "min_cancel": "P1D",
15
  "min_length": 1,
16
  "max_length": 1,
17
  "pre_time": 0,
18
  "post_time": 0,
19
  "booking_type": 3,
20
  "mbooking_type": 5,
21
  "visibility_type": "public"
22
}

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

application/json

200Service