Update service

The service can optionally be limited to specific hours of the day. The calendar attribute needs to be present. Use weekly_allowance_plan to set both booking and working hours: { "calendar": { "weekly_allowance_plan": [ {}, { "isActive": true, "times": [{ "begin": "10:00", "end": "12:00" }] }, {}, {}, {}, { "isActive": true, "times": [{ "begin": "10:00", "end": "12:00" }] }, {} ], "region": "EUROPE", "timezone": "Europe/Berlin" } } Clear calendar: { "calendar": null } | Preserve existing: omit calendar field

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the service.

Query Params
integer

The "external" attribute specifies if the search query will use the external or TIMIFY ID. When "external" is set as 1, "serviceId" is used as the "externalId", alternatively the "serviceId" is the TIMIFY id.

Body Params
string
required

Name of the service

integer

Duration is in intervals of 5 minutes.

durations_pattern[]
array of integers

Duration patterns is an array of duration intervals that are permitted for the service.
All appointments for the service is stored in multiple intervals
One of the values is required: duration or durations_pattern
Example: /?durations_pattern[]=20,40,20

durations_pattern[]
dependencies
array of objects

Dependencies are an array of objects. Dependencies are defined as resources or objects (equipment or location) that are required for the appointment.

  {
    "resources": ARRAY,
    "categories": ARRAY,
    "work_parallel": BOOL // true - all resources need to be available for the appointment
  }
 ]

Only resources or categories are required
Categories required:
In the event resources from multiple categories are required, use the categories parameter.

{
  ...
  "categories": [
      "602a6f4d7f5940108ebe8919",
      "5c8881c3cf4b1d2ec26378b0"
  ],
  "resources": null,
  "workParallel": false,
  ...
}

Resources required:
In the event specific resources are required, the resource parameter is used.

{
  ...
  "categories": null,
  "resources": [
      "602d45bf78b735114fd56592",
      "5c94d6d59beaa25c7c800324"
  ],
  "workParallel": false,
  ...
}

Prioritisation and duration optimisation
Each dependency supports one assignment mode: automatic (load-balanced), manual priority ordering (has_prioritized_resource_categories or has_prioritized_resources), or duration-based optimisation (booking_duration_per_resource_categories or booking_duration_per_resources). These modes are mutually exclusive within a single dependency, and only one dependency per service may use duration-based optimisation. Prioritisation and duration optimisation are not supported on dependencies where work_parallel is true.
When updating a service, re-submit any priority or duration configuration alongside the dependency — it is not preserved automatically. Switching a dependency from category-based to resource-based scheduling (or vice versa) resets all prioritisation settings to automatic assignment.

dependencies
attributes
array of objects

Define customizations fields for your service.
Either id or external_id is required.
Either value or values is required.
WARNING: Passing attributes in the request body will overwrite the default value/s on the attribute for this service.
If you wish to keep the default configuration of the attributes, do not provide attributes in the request body.
Example data in request:

[
  {
    "id": STRING, // or external_id
    "external_id": STRING, // or id
    "value": STRING, // or values
    "values": ARRAY // or value
  }
]
attributes
string

External Id of the service

string

Id of service category

string

Description of the service

integer

Time required to prepare for an appointment, specified in 5-minute intervals.

integer

Time required after an appointment, specified in 5-minute intervals.

string

Price of the service in float format, ie 12.00.

string | null

Display currency as an ISO 4217 code (for example EUR). Send null to clear it and fall back to the company's currency.

boolean

Enable online payment.

boolean

Enable appointments for the service.

boolean

Payment required for the appointment.

string
enum

The Color of the resource in HEX format.

calendar
object | null
  • When provided with data: Sets the service calendar
  • When explicitly null: Clears/removes the service calendar
  • When omitted: Preserves existing calendar
booking_limit
object
maximum_lead_time
object

Maximum time for appointment scheduling. For WEEKS frequency the value needs to be between 0 and 60. For MONTHS frequency value needs to be between 0 and 12

minimum_lead_time
object

Minimum time for appointment scheduling. For HOURS frequency the value needs to be between 0 and 1440. For DAYS frequency value needs to be between 0 and 60

cancellation_lead_time
object

Minimum time for appointment cancellation. For HOURS frequency the value needs to be between 0 and 48. For DAYS frequency value needs to be between 0 and 2

location
object

A custom location where the appointment will be held, supports custom address or online meeting.

online_booking_blocked_intervals
array of objects

Define a list of dates where the service will not be bookable.
Example data in request:

[
  {
    "begin": DATE_STRING, // or 2020-01-01
    "end": DATE_STRING // or 2020-01-02
  }
]
online_booking_blocked_intervals
Headers
string
required

Id of the company

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json