Create Service

post

https://api.vcita.biz/v2/settings/services

Overview

Creates a new service for the business. This is the write endpoint for services — the read-only list is at GET /platform/v1/services.

Available for Staff tokens.

Important

POST /platform/v1/services does NOT exist (returns 404). Always use this endpoint (POST /v2/settings/services) to create services.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Display name of the service (e.g., "Executive Strategy Consultation").

service_type

string

enum

Defaults to appointment

The kind of service to create. Use appointment for standard one-on-one services (default) or event for group events/workshops.

Allowed:

duration

integer

required

Duration of the service in minutes (e.g., 30, 45, 60).

charge_type

string

enum

How the service is charged. no_price for free services, paid for priced services, free for explicitly free services.

Allowed:

price

number

Price of the service in the smallest currency unit. Set to 0 for free services.

currency

string

ISO 4217 currency code (e.g., "USD", "EUR").

interaction_type

string

enum

required

How and where the service is delivered. Face-to-face types: default_business_location (uses the business address on file), business_location (custom address — provide in meeting_interaction_details), client_location (client provides location). Phone types: business_phone (provide number in meeting_interaction_details), client_phone (client provides number). Online types: online (provide URL in meeting_interaction_details), zoom (auto-generated Zoom link), skype (provide Skype name in meeting_interaction_details).

meeting_interaction_details

string

Location/contact details for the service. The meaning depends on interaction_type: address for business_location, phone number for business_phone, URL for online, Skype name for skype. Required when interaction_type is business_location, business_phone, online, or skype. Not needed for default_business_location, client_location, client_phone, or zoom (these are auto-resolved or client-provided).

description

string

A detailed description of the service shown to clients.

display

boolean

Whether the service is visible in the client-facing booking page. Defaults to true.

approval_mode

string

enum

How bookings for this service are approved. immediate for auto-approval, manual for staff review.

Allowed:

staff_data

array of objects

Array of staff assignment objects. Each object maps a staff member to this service. The booking system uses this to determine which staff members can offer this service — if omitted, no staff will be associated and booking attempts will fail with 'The provided staff member doesn't offer the provided service'.

staff_data

200Service created successfully.