Thanks to visit codestin.com
Credit goes to docs.timify.dev

Create appointment with combination service

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
Codestin Search AppLoading…
Body Params
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 in intervals of 5 minutes.

integer

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

integer

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

duration_pattern
array of integers

Duration pattern in intervals of 5 minutes.

duration_pattern
string
required

The ID of the service (required).

string

Title of the appointment.

string

A note for the appointment.

string
enum

The Color of the resource in HEX format.

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

Maximum amount of participants that can join a course.

string

ID of the customer for the appointment.

boolean

If true, the resource will receive email confirmation of the appointment.

boolean

If true, the customer will receive email confirmation of the appointment. This feature is only available if the customer ID is present.

participants
array of objects

Array of participants for courses.

participants
string

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

integer

Reserve the appointment for a set amount of minutes

customer_reminders_minutes
array of integers

Array of minutes before appointment to send customer reminders

customer_reminders_minutes
resource_reminders_minutes
array of integers

Array of minutes before appointment to send resource reminders

resource_reminders_minutes
string
enum
required

Timezone for the appointment (required)

combination_services
array of objects
required

Array of services to combine in the appointment. Each service must have a service_id and duration. Resource IDs are required if the service needs specific resources.

combination_services*
boolean

Skip conflict checking on chained appointments

Headers
string
required

Id of the company

Responses

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