Update group service

patch

https://api.timify.com/v1/group-services/{groupServiceId}

The URL parameter "groupServiceId" can be used in two ways:

use the unique ID of the group service assigned by TIMIFY ("groupServiceId"). In this case, you don't need the QUERY parameter "external"
use the "externalId" that you added to this service. In this case, you need to add the parameter "external" ( for ex.: /?external=1) so the Developer API will search by your "externalId" and not by "groupServiceId" assigned by TIMIFY

You can add "externalId" to the group service with the Developer API

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

groupServiceId

string

required

ID of the group service.

Query Params

external

string

enum

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

Allowed:

Body Params

name

string

required

Name of the group service

duration

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

durations_pattern[]

dependencies

array of objects

  "resources": ARRAY,
  "categories": ARRAY,
  "work_parallel": BOOL // *TRUE* - all resources are required during the appointment
} ```
__One of the parameters is required: resources or categories__
Define dependencies as an array of objects:

``` Example: {
  "resources": ["id1", "id2"],
  "categories": ["id1", "id2"],
  "work_parallel": true
} ```

dependencies

external_id

string

External Id of the group service

category_id

string

Id of group service category

description

string

Description of the group service

duration_before

integer

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

duration_after

integer

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

price

string

Price of the service in float format, ie 12.00.

currency

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.

has_online_payment

boolean

Enable online payment.

is_bookable

boolean

Enable appointments for the service.

is_payment_mandatory

boolean

Payment required for the appointment.

max_participants

integer

Max number of participants for this group service

extra_persons

integer | null

Default number of extra persons per participant allowed for the group service.

is_stalled

boolean

color

string

enum

The Color of the resource in HEX format.

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

attributes

array of objects

Define customizations fields for course.
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

location

object

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

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Expected response to a valid request

400Bad Request

500Internal Server Error