Skip to main content

Create Service

Create a new service in the calendar system.

Request

POST /v2/services

Headers

NameRequiredDescription
x-api-keyYesYour API key
x-api-secretYesYour API secret

Body Parameters

ParameterTypeRequiredDescription
namestringYesName of the service
descriptionstringNoDetailed description of the service
imageUrlstringNoURL of the service image
dateRangesarrayNoDate ranges when the service is available
bookingOptionsobjectNoConfiguration for booking rules
calendarsarrayNoCalendars associated with this service
extraFieldsobjectNoAdditional custom fields

Response

Success Response (201 Created)

{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Professional Consultation",
"description": "A comprehensive consultation service",
"imageUrl": "https://example.com/service-image.png",
"dateRanges": [
{
"start": "2025-05-22T10:30:00Z",
"end": "2025-05-22T18:30:00Z"
}
],
"bookingOptions": {
"duration": 60,
"bufferTime": 15,
"maxParticipants": 1,
"autoAccept": true
},
"createdAt": "2025-05-22T10:30:00Z",
"updatedAt": "2025-05-22T10:30:00Z"
}

Error Responses

StatusDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key or secret
403Forbidden - Insufficient permissions
409Conflict - Service with same name already exists