Recurring appointments API

The Recurring API enables programmatic creation of recurring appointmentsRecurring appointmentAn appointment that repeats on a schedule - weekly, monthly - that you manage as one series instead of re-creating it each time.. It exposes the same functionality as the UI's recurring-appointment feature, accessible through an API endpoint so you can automate recurring appointment patterns without manual intervention.

Endpoint

POST /appointmentRecurring

For the full reference, see the API Reference.

What it does

The Recurring API mirrors the UI's recurring-appointment feature, but exposes it programmatically. 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: resourceResourceAn entity that can carry out work - a person, vehicle, tool, or room - that you schedule on the planning board. identifier.
• taskNo: task number (optional).
• jobNo: job number (optional).
• categoryName: categoryCategoryA visual indicator (a color) applied to appointments to classify or label them. name (optional).
• timeMarkerName: time markerTime markerA visual indicator on an appointment, separate from its category, used to flag a status or condition at a point in time. name (optional).
• recurrenceRule: recurrence rule defining the pattern (e.g. daily, weekly, monthly).
• subject: appointment subject (optional).
• body: appointment body/description (optional).