Skip to content

Repeat an Appointment

Request

Creates copies of an Appointment on the dates produced by a repeat rule, for example "every Tuesday until the end of the month" or "10 times every other day". Copies keep the Team Member, Services, duration and Resource Instances of the original.

The dates are calculated and checked synchronously: the request fails if a date is busy for the Team Member or its Resource Instances, unless force is true. The copies are then created asynchronously, so they appear in the Appointment list shortly after the response. meta.count is the number of copies scheduled. A second request for the same Appointment while copies are still being created returns 429.

Event Appointments cannot be repeated. The Business User needs the permission to create Appointments.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Example:4564
record_idintegerrequired

ID of the Appointment to repeat

Example:671726526
Headers
Acceptstringrequired
Default:"application/vnd.api.v2+json"
Content-Typestringrequired
Default:"application/json"
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
strategyobjectrequired

Repeat rule. Use the values of a saved repeat template or a one-off rule.

fromstring, (date)required

First date to consider for copies (YYYY-MM-DD). The original Appointment's own date and time are skipped.

tillstring, (date)

Last date to consider (YYYY-MM-DD), inclusive. Required unless count is set; must be after from.

countinteger, [ 1 .. 100 ]

Number of copies to create. Required unless till is set; ignored when till is set.

hoursinteger, [ 0 .. 23 ]

Start hour of the copies. Defaults to the original Appointment's hour.

minutesinteger, [ 0 .. 59 ]

Start minute of the copies. Defaults to the original Appointment's minute.

forceboolean

Create copies even when a date is busy for the Team Member or its Resource Instances.

Default:false
duplication_settingsobject
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/4564/appointments/671726526/duplicate \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "strategy": {
      "repeat_mode": "week",
      "interval": 0,
      "days": [
        2
      ]
    },
    "from": "2026-11-01",
    "till": "2026-11-30",
    "duplication_settings": {
      "with_client": true
    }
  }'

Responses

Created. Copies are being created asynchronously.

Bodyapplication/json
successboolean
datanull
metaobject
Response
{ "success": true, "data": null, "meta": { "count": 4 } }