Update Service

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

Updates an existing service.

Path Params

company_id

int32

required

int32

required

Body Params

name

string

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

client_queue_id

int32

spaces

int32

Defaults to 1

duration

int32

Duration

disabled

boolean

Disabled

description

string

Description

category_id

int32

Category ID

max_advance_applies

string

Maximum Advance Applies To

max_advance

string

Maximum Advance

min_advance_applies

string

Minimum Advance Applies To

min_advance

string

Minimum Advance

min_cancel_applies

string

Minimum Cancel Applies To

min_cancel

string

Minimum Cancel

rules_group_id

int32

Rules Group ID

group_id

int32

Group ID

schedule_id

int32

Schedule ID

disable_before_date

date

Disable Before Date

disable_after_date

date

Disable After Date

min_length

int32

1 to 20

Minimum Length

max_length

int32

1 to 20

Maximum Length

question_group_id

int32

Question Group ID

order

int32

pre_time

int32

Default Pre-Time

post_time

int32

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

Non-Members Booking

mbooking_type

int32

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

can_refund_automatically

boolean

Whether the price of this service will be refunded if the customer cancels within the min cancellation time

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

Combine resources and staff in the widget

fixed_start_times

boolean

Fixed start times

confirmable_by

int32

Customer Confirmable

fairness_strategy

string

Fairness Strategy

service_booking_types

object

visibility_type

string

Visibility Type

configured_durations

array of objects

configured_durations

Responses

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

403

Forbidden

404

Not Found

Language

Credentials

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://example.jrni.com/api/v5/admin/company_id/services/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"spaces":1}'

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

application/json

200Service