Delete Booking Service
This endpoint allows you to permanently remove a booking service from the system. This operation cannot be undone and should be used with caution, especially if there are existing appointments.
πΉ Endpoint Detailsβ
DELETE /api/v1/booking-services/{id}
π Authenticationβ
Header | Required | Description |
---|---|---|
Content-Type | Yes | Must be application/json |
Authorization | Yes | Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature |
π Request Structureβ
Path Parametersβ
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
id | string (UUID) | Yes | Unique identifier of the service to delete | 1610c525-f19a-40d0-8cd1-03daba3d2d98 |
π§© Request Exampleβ
curl -X DELETE "https://openapi.onlive.site/api/v1/booking-services/1610c525-f19a-40d0-8cd1-03daba3d2d98" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"
π€ Response Formatβ
Successful Response (200 OK)β
{
"id": "1610c525-f19a-40d0-8cd1-03daba3d2d98",
"name": "Test Drive Standard",
"duration": 30,
"createdAt": "2025-03-09T19:32:03.735Z",
"updatedAt": "2025-03-09T19:32:06.669Z",
"deletedAt": "2025-03-09T20:00:00.000Z"
}
β Error Responsesβ
401 Unauthorizedβ
{
"statusCode": 401,
"message": "Invalid or missing authorization credentials"
}
403 Forbiddenβ
{
"statusCode": 403,
"message": "Cannot delete service with active appointments"
}
404 Not Foundβ
{
"statusCode": 404,
"message": "Service not found"
}
π Notesβ
- This operation permanently removes the service
- All service configuration will be deleted
- Future appointments will be affected
- The deletion cannot be undone
- System tracks deletion time (
deletedAt
) - Only services in your organization can be deleted
- Consider using deactivation instead of deletion
β οΈ Pre-deletion Checklistβ
-
Appointment Review
- Check for existing appointments
- Notify affected users
- Consider rescheduling options
-
Resource Review
- Check calendar associations
- Review asset assignments
- Document configurations
-
System Impact
- Evaluate scheduling impact
- Check integration dependencies
- Review automated processes
π Post-deletion Actionsβ
-
System Updates
- Update service listings
- Adjust calendar availability
- Clean up asset associations
-
User Communication
- Notify affected users
- Update service catalogs
- Remove from bookings
-
Data Management
- Archive service data
- Update reports
- Clean cache
β Best Practicesβ
- π Verify ID: Double-check service ID before deletion
- π Document Reason: Keep records of deletion reasons
- π Access Control: Ensure proper authorization
- π± Notification: Inform relevant stakeholders
- π Alternative: Consider deactivating instead of deleting
π« Limitationsβ
-
Cannot Delete If
- Active appointments exist
- Service is in use by integrations
- Required by system processes
-
System Constraints
- Operation is permanent
- No partial deletion
- All or nothing process