Updates an existing appointment

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

ID of the appointment. You add this in the request URL path.

Body Params
resource_ids
array of strings

IDs of resources (employees or objects).Mutually exclusive with external_resource_ids.

resource_ids
external_resource_ids
array of strings

External IDs of resources (employees or objects).Mutually exclusive with resource_ids.

external_resource_ids
date-time
required

Start date & time of the appointment in the format YYYY-MM-DD HH:MM. Example: 2019-02-23 14:22 The DateTime value should be in the timezone UTC

integer

Duration is in intervals of 5 minutes.
Duration is an optional parameter if the service id is present. When both are present in the request, duration overrides the duration of the service.
Duration is required when title parameter is present.

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

The ID of the service.
Service ID or title is a required parameter.

string

Title of the appointment.
Service ID or title is a required parameter.
Title is used if the appointment does not match any of the predefined services.

string

A note for the appointment.

string
enum

The Color of the resource in HEX format.

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

The value is "TRUE" if the appointment is for a group-service.

boolean

Is the appointment for a course/group-service available for online booking.
This option is not available for normal services

integer

Required for courses, maximum amount of participants that can join a course. if not set, the default value from the service will be used.

integer

Max amount of extra slots per participant. if not set, the default value from the service will be used.

string

Required for single services.

boolean

Required if the resource needs to receive email confirmation of the appointment.

boolean

Required if the customer needs to receive email confirmation of the appointment.
This feature is only available if the customer ID is present.

participants
array of objects

Required for courses. Example: participants: [ { "customer_id": '5f69ee2cdd746d69167887bc', "extra_persons": 2, fields: [{id: '689dcfde3bb20f7f1b3796e4', value: "true"}] } ] WARNING!!!! On update, if the participant array is not present, the data is deleted

participants
integer

External Id of the appointment

recurring
object

Recurring appointment required parameters: - timezone - the timezone is required if the company's timezone is not UTC. - frequency - permitted values are "DAYS', "WEEKS", "MONTHS" or "YEARS". - repeat_last_date - specify the end date for the recurring bookings. or - repeat_times - specify the count of recurring bookings. - week_days - specify the weekdays that appointments occur on. The value is an array of integers, 0 represents Sunday and 6 Saturday. This parameter is required if the frequency is "WEEKS". - month_days - specify the days of the month the appointment occurs. The value is an array of integers. The count starts from 0. This parameter is required if the frequency is "MONTHS". - year_months - specify the months the appointment occurs. The count starts from 0. This parameter is required if the frequency is "YEARS" - is_fixed_by_recurring_day - Set to True if you want to repeat a reservation periodically defined in the frequency parameter. - are_single_events - set to true when the bookings will be single appointments in the calendar.type: object

string

An array of custom data fields of the appointment. Each item in the array is an object with the id and value of the custom field. The format of the object is:

  {
    "id": "value",
    "value": "value"
  }

Custom Fields like "Phone" require a different structure. The following is an example of storing a phone number:

  {
    "id": "5f61c6381a34817e5c7fa218",
    "value": "{\"number\":\"123456789\",\"country\":\"DE\"}"
  }

Note the value param needs to be a string. For example, you need to use JSON.stringify() or the equivalent in the programming language of your integration.
Adding files: First, upload the file(s) using the corresponding endpoint.
The response will resemble this structure:

  "url": "https://s3.eu-central-1.amazonaws.com/data.timify.com/temporary/2022-02-10_12/private-uploads/my-picture.png",
  "key": "temporary/2022-02-10_12/private-uploads/my-picture.png"
} ```
Add the following custom field:
``` {
  "id": "612cdd6cda1af85e64419256",
  "values_add": [
    {
      "key":"temporary/2022-02-10_12/private-uploads/profile-picture.png",
      "name": "profile-picture.png"
    }
  ],
  "values_remove": [
    "https://s3.eu-central-1.amazonaws.com/data.timify.com/private-uploads/6006f0e2b2d180176c2a3361/d4af4379-c075-4d0e-9c80-24e0287205b8.png"
  ]
} ```
If the data field has multiple files, add all files in an array following the same data structure.
string
enum
Allowed:
tag_ids
array of strings

An array of tag ids
These tags can be used to group appointments together and enable searching and filtering

tag_ids
metadata
array of objects

An array of dynamic data
Metadata is a holder for all extra information you want stored against the appointment

metadata
integer

Imported Id of the appointment

boolean
integer
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