Creates a Service Item

Assets (assets), this parameters describe a list of rules which a time must
satisfy to be considered available.
An Asset consists of a

  • company_rule -> can be either default (it will respect the company of the URL), any (it can be any company that provides the service), or Array<CompanyID> one of these companies (which must provide the service).
  • person_rule -> can be either any (any person which provides the service), any_or_none (the user is indifferent as to whether a person is associated to the booking), Array<PersonID> one of these people who provide the service.
  • resource_rule -> same as person_rule: can be either any (any resource which provides the service), any_or_none (the user is indifferent as to whether a resource is associated to the booking), Array<PersonID> one of these resources with which the service can be provided.
Recipes
📆
Service first customer appointment booking journey
Open Recipe
🗒️
Fetch Booking Questions to capture customer data
Open Recipe
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
string
int32
required

The global_id of the service which is being booked

string
required

Date time in which the appointment will take place

int32

Duration of the appointment, in minutes. Must be one of the durations of the service

int32

The branch in which the appointment is taking place

int32

The staff member that will participate in the appointment

int32

The resource that will be used in the appointment

array

This asset must be on a company matching a rule. Valid values: 'default', 'any', Array

assets[company_rule]
array

This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array

assets[person_rule]
array

This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array

assets[resource_rule]
array of int32s

Pre Time. Overrides service configuration

assets[pre_time]
array of int32s

Post Time. Overrides service configuration

assets[post_time]
array of int32s

Person Group ID. This will overwrite the person_rule

assets[person_group_id]
array of int32s

Resource Group ID. This will overwrite the resource_rule

assets[resource_group_id]
array

This asset must be on a company matching a rule. Valid values: 'default', 'any', Array. requested_assets is deprecated, please assets

requested_assets[company_rule]
array

This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array. requested_assets is deprecated, please assets

requested_assets[person_rule]
array

This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array. requested_assets is deprecated, please assets

requested_assets[resource_rule]
array of int32s
required
questions[id]*
array of strings
required
questions[answer]*
int32

Pre Time. Overrides service configuration

int32

Post Time. Overrides service configuration

string

The time zone the booking was made in

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.bookingbug-hal-v2+json; charset=utf-8
application/vnd.bookingbug-nolinks-v2+json; charset=utf-8