Skip to main content

Delete Appointment

This endpoint allows you to delete an existing appointment from the system. This operation is permanent and cannot be undone.

🔹 Endpoint Details​

DELETE /api/v2/appointments/{id}

🔒 Authentication​

HeaderRequiredDescription
Content-TypeYesMust be application/json
AuthorizationYesFormat: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

🧩 Request Examples​

Basic Delete Request​

curl -X DELETE "https://openapi.onlive.site/api/v2/appointments/1610c525-f19a-40d0-8cd1-03daba3d2d98" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

Delete with Query Filters​

curl -X DELETE "https://openapi.onlive.site/api/v2/appointments/1610c525-f19a-40d0-8cd1-03daba3d2d98" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

📤 Response Format​

Success Response (200 OK)​

{
  "id": "1610c525-f19a-40d0-8cd1-03daba3d2d98",
  "deletedAt": "2025-03-09T19:32:06.669Z",
  "createdAt": "2025-03-09T19:32:03.735Z",
  "updatedAt": "2025-03-09T19:32:06.669Z",
  "title": "Test Drive Standard",
  "description": "",
  "lang": "es",
  "startAt": "2025-03-10T08:00:00.000Z",
  "endAt": "2025-03-10T08:30:00.000Z",
  "calendarIds": ["af6c6be0-689a-4cf3-a8c8-550dd97b3a6b"],
  "serviceId": "01392598-e4b2-4810-ac7c-8c9cf4286a26",
  "status": "pending",
  "origin": "onlive_public",
  "organizationId": "26d47eec-c742-4b1c-9d70-9a1486260abd",
  "userGroupId": "1be7bf10-5c72-480b-b0d7-1c2bb023225d"
}

❌ Error Responses​

This endpoint follows the standard error format.

🔄 Side Effects​

When an appointment is deleted:

  1. Notification Actions

    • All associated guests are notified (if configured)
    • Calendar owner is notified
    • Service provider is notified (if applicable)

  2. Resource Updates

    • Calendar availability is updated
    • Service slots are freed
    • Related resources are released
    • Linked video conferences are cancelled

  3. System Updates

    • Historical records are maintained
    • Audit logs are updated
    • Analytics are adjusted
    • Search indexes are updated

🔐 Required Permissions​

  1. Basic Delete Permission
    • Organization-level delete permission
    • Calendar-specific delete permission (if applicable)
    • Service-specific delete permission (if appointment is tied to a service)

💡 Best Practices​

  1. Pre-deletion Checks

    • Confirm deletion intent with users
    • Check appointment status
    • Verify guest notification preferences
    • Review linked resources

  2. Deletion Strategy

    • Consider using cancellation for future appointments
    • Archive important information before deletion
    • Document deletion reasons
    • Handle recurring appointments properly

  3. Error Handling

    • Implement proper rollback mechanisms
    • Handle notification failures gracefully
    • Log deletion failures
    • Monitor deletion patterns

  4. User Communication

    • Send clear cancellation notices
    • Include rescheduling options
    • Provide support contact
    • Explain deletion reasons

📘 Notes​

  1. Data Retention

    • Soft deletion is used by default
    • Data retained for compliance period
    • Audit logs maintained indefinitely
    • Recovery possible within retention period

  2. Compliance

    • State changes tracked