Update a Schedule

Request

Updates the settings of a schedule containing appointments or events.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

schedule_idintegerrequired

ID of a schedule.

Example:123

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

date_endstring, (date)

Date of the schedule end.

Example:"2022-02-01"

curl -i -X PATCH \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/schedules/123 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2022-02-01"
  }'

Responses

OK

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataobject(Object of model "Schedule")

Data for an existing schedule 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,
  "original_entity_type": "activity",
  "original_entity_id": 123,
  "date_start": "2026-01-01",
  "date_end": "2026-02-01",
  "days": [
    { … }
  ]
}

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,
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_start": "2026-01-01",
    "date_end": "2026-02-01",
    "days": [ … ]
  },
  "meta": {}
}