Skip to content
/
Update a schedule series

Update a schedule series

Request

Updates the settings of a schedule series for appointments or events.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example:123
schedule_idintegerrequired

ID of a schedule.

Example:123
day_idnumberrequired

ID of a schedule series.

Example:123
Query
includeArray of strings

Requested set of an included models.

Items Enum:"events_master""events_labels""events_resource_instances""events"
Headers
Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Content-Typestringrequired

Should be equal to application/json

Example:application/json
Bodyapplication/json
forcebooleanrequired

Flag for force override of manual changes in scheduled appointments/events.

Example:false
events_master_idnumber

The ID of the team member assigned to the events in the schedule series.

Example:123
events_timestring

Start time of the events in the schedule series, formatted as HH:MM:SS.

Example:"14:00:00"
events_durationnumber

Duration of each event in the schedule series, in seconds.

Example:3600
events_capacitynumber

The capacity of activities in the schedule series. For appointments, this should be set to 1.

Example:4
labels_idsArray of numbers

An array of tag IDs associated with the events in the schedule series.

Example:
[
  123
]
resource_instance_idsArray of numbers

An array of resource instance IDs used in the events of the schedule series.

Example:
[
  123
]
curl -i -X PATCH \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/schedules/123/days/123?include=events_master' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "force": false,
    "events_master_id": 123,
    "events_time": "14:00:00",
    "events_duration": 3600,
    "events_capacity": 4,
    "labels_ids": [
      123
    ],
    "resource_instance_ids": [
      123
    ]
  }'

Responses

OK

Bodyapplication/json
successboolean(Successful response status)

Response status.

Example:true
dataobject(Object of model "Schedule Series")

Data for an existing schedule series in a location.

Example:
{
  "id": 123,
  "created_at": "2026-01-01T12:12:12-05:00",
  "updated_at": "2026-01-01T12:12:12-05:00",
  "deleted_at": null,
  "timetable_event_schedule_id": 123,
  "day_of_week": "mon",
  "events_time": "14:00:00",
  "events_duration": 3600,
  "event_technical_break_duration": 0,
  "events_master": {
    "id": 123,
    "name": "John Johnson",
    "company_id": 123,
    "specialization": "Team Member",
    "avatar": "https://app.alteg.io/images/no-master-sm.png",
    "avatar_big": "https://app.alteg.io/images/no-master.png",
    "position": { … }
  },
  "events_labels": [
    { … }
  ],
  "events_resource_instances": [
    { … }
  ],
  "events": [
    { … }
  ]
}
metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:
{}
Response
{
  "success": true,
  "data": {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "timetable_event_schedule_id": 123,
    "day_of_week": "mon",
    "events_time": "14:00:00",
    "events_duration": 3600,
    "event_technical_break_duration": 0,
    "events_master": { … },
    "events_labels": [ … ],
    "events_resource_instances": [ … ],
    "events": [ … ]
  },
  "meta": {}
}