Services

Update Service

Use this endpoint to Update a service object. A valid service id is required.

put/setup/v1/services/{id}

Request

Base URL
https://sandbox-api.onsched.com
Auth
OAuth 2
Client credentials
Token URLhttps://sandbox-identity.onsched.com/connect/token
ScopesOnSchedApi
TypeScript
https://skmtc.dev/onsched/apis/onsched-setup-api/docs/setup/v1/services/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Request body

locationIdstring nullable

namestring nullable

descriptionstring nullable

typestring nullable

durationinteger nullable

bookingLimitinteger nullable

bookingIntervalinteger nullable

maxCapacityinteger nullable

maxGroupSizeinteger nullable

serviceGroupIdstring nullable

publicboolean nullable

mediaPageUrlstring nullable

Response

Success

objectstring nullable

idstring nullable

companyIdstring nullable

locationIdstring nullable

namestring nullable

descriptionstring nullable

typestring nullable

imageUrlstring nullable

mediaPageUrlstring nullable

serviceGroupIdinteger nullable

serviceGroupNamestring nullable

calendarIdstring nullable

calendarResourceGroupIdstring nullable

bookingLimitinteger

bookingIntervalinteger

bookAheadUnitinteger

bookAheadValueinteger

bookInAdvanceinteger

roundRobininteger

showOnlineboolean

defaultServiceboolean

durationinteger

durationSelectboolean

durationMininteger

durationMaxinteger

durationIntervalinteger

paddinginteger

consumerPaddingboolean

feeAmountnumber double

feeTaxableboolean

cancellationFeeAmountnumber double

cancellationFeeTaxableboolean

nonRefundableboolean

dailyBookingLimitCountinteger

dailyBookingLimitMinutesinteger

maxBookingLimitinteger

maxResourceBookingLimitinteger

maxCapacityinteger

maxGroupSizeinteger

Changes

No recorded changes to this operation across all 1 revision of this API.