Recurring API

Status: Preview

This feature is currently in preview and available for testing in the sandbox environment.

The Recurring API enables programmatic creation of recurring appointments, providing the same functionality as the UI but accessible through an API endpoint. This allows you to automate the creation of recurring appointment patterns without manual intervention.

API Endpoint

The Recurring API is available at:

POST /appointmentRecurring

For detailed API documentation, see the API Reference.

What It Does

The Recurring API does the same thing as the UI's recurring appointment feature, but allows you to create recurring appointments programmatically. This is particularly useful for:

• Automating appointment creation workflows
• Integrating with external systems that need to schedule recurring appointments
• Bulk creation of recurring appointment patterns
• Scripting and automation scenarios

Example Request

curl https://sandbox.api.dimescheduler.com/appointmentRecurring \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "startDate": "",
  "endDate": "",
  "resource": "",
  "taskNo": null,
  "jobNo": null,
  "categoryName": null,
  "timeMarkerName": null,
  "recurrenceRule": "",
  "subject": null,
  "body": null
}'

Request Parameters

• startDate: Start date for the recurring appointment series
• endDate: End date for the recurring appointment series
• resource: Resource identifier
• taskNo: Task number (optional)
• jobNo: Job number (optional)
• categoryName: Category name (optional)
• timeMarkerName: Time marker name (optional)
• recurrenceRule: Recurrence rule defining the pattern (e.g., daily, weekly, monthly)
• subject: Appointment subject (optional)
• body: Appointment body/description (optional)