Create service

Create a new service in the account.

Authorization

authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

Service params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a service.

appointment_type?string

The type of appointment.

Value in

"in_person"
"virtual"

booking_policy?

A booking policy defines the rules for booking a service from public booking interfaces.

buffer_policy?

A policy for keeping time before and/or after appointments free of other bookings and busy external calendar events (e.g. prep time before, charting time after). The policy is captured on the appointment at booking time and continues to shield the surrounding time even if the service configuration changes later.

cancellation_policy?

A cancellation policy defines the rules for canceling a service from public booking interfaces.

change_policy_text?string

Displayed to clients in follow-up communication. Use this to explain any important rules about cancellations or rescheduling.

duration?string

The duration of time slots in ISO-8601 duration format.

Match^PT(?:(\d+)H)?(?:(\d+)M)?$

form_ids?array<>

Optional list of form IDs to attach to the service. Each form is attached as required, with sort order matching the array order.

internal_name?|

An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name.

metadata?

Set of key-value pairs to attach to this service. Maximum size is 16 KB.

name*string

The service name.

provider_notifications?

Configuration for staff notification emails on a service, including which notification types are enabled and who receives them.

rescheduling_policy?

A rescheduling policy defines the rules for rescheduling a service from public booking interfaces.

slot_rules?array<>

Array of slot rules for the service.

Response Body

`application/json`

curl -X POST "https://example.com/v1/services" \  -H "Content-Type: application/json" \  -d '{    "appointment_type": "virtual",    "booking_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_booking": true,      "disabled_message": "Booking is disabled for this service.",      "hold": {        "duration": "PT10M",        "enabled": true      },      "maximize_utilization": {        "enabled": true      }    },    "buffer_policy": {      "after_duration": "PT1H",      "before_duration": "PT15M",      "enabled": true    },    "cancellation_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_cancellation": true,      "disabled_message": "Cancellation is disabled for this service."    },    "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",    "duration": "PT1H30M",    "internal_name": "IC - New Patient",    "metadata": {      "external_id": "123"    },    "name": "Initial Consult",    "provider_notifications": {      "additional_recipients": [        "admin@example.com"      ],      "notify_provider": true,      "types": [        {          "type": "new_appointment"        }      ]    },    "rescheduling_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_rescheduling": true,      "disabled_message": "Rescheduling is disabled for this service."    },    "slot_rules": [      {        "recurrence_rule": {          "byday": [            "mo",            "we",            "fr"          ],          "freq": "weekly"        },        "start_times": [          "09:00",          "10:00"        ]      }    ]  }'

{  "data": {    "appointment_type": "in_person",    "booking_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_booking": true,      "disabled_message": "Booking is disabled for this service.",      "hold": {        "duration": "PT10M",        "enabled": true      },      "maximize_utilization": {        "enabled": true      }    },    "buffer_policy": {      "after_duration": "PT1H",      "before_duration": "PT15M",      "enabled": true    },    "cancellation_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_cancellation": true,      "disabled_message": "Cancellation is disabled for this service."    },    "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",    "created_at": "2025-02-17T17:49:19Z",    "duration": "PT1H30M",    "forms": [      {        "created_at": "2025-02-17T17:49:19Z",        "form_id": "frm_d025a96ac0c6",        "form_name": "Intake Form",        "id": "sf_d025a96ac0c6",        "object": "service_form",        "sort_order": 1,        "updated_at": "2025-02-17T17:49:19Z"      }    ],    "id": "srv_d025a96ac0c6",    "internal_name": null,    "metadata": {      "external_id": "123"    },    "name": "Initial Consult",    "object": "service",    "provider_notifications": {      "additional_recipients": [        "admin@example.com"      ],      "notify_provider": true,      "types": [        {          "type": "new_appointment"        }      ]    },    "rescheduling_policy": {      "advance_notice": {        "enabled": true,        "minimum_duration": "PT1H"      },      "allow_rescheduling": true,      "disabled_message": "Rescheduling is disabled for this service."    },    "slot_rules": [      {        "recurrence_rule": {          "byday": [            "mo",            "we",            "fr"          ],          "freq": "weekly"        },        "start_times": [          "09:00",          "10:00"        ]      }    ],    "updated_at": "2025-02-17T17:49:19Z"  }}

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`