Skip to main content

This page is also available as plain markdown · OpenAPI spec

Update recurring schedule

PATCH 
/events/:eventId/recurring_schedules/:id

Update recurring schedule

Request​

Path Parameters

    eventIdstringrequired
    Example: 00000000-0000-0000-0000-000000000000
    idstringrequired
    Example: 00000000-0000-0000-0000-000000000000

Body

timestring
fromOccurrenceIdstring
endsobject
typestringrequired
countintegerrequired
weekdaystring
Example (auto)
{
  "time": "string",
  "fromOccurrenceId": "string",
  "ends": {
    "type": "string",
    "count": 0
  },
  "weekday": "string"
}

200

Updates a schedule in place
objectstringrequired
idstringrequired
eventIdstringrequired
frequencystringrequired
startDatestringrequired
timestringrequired
durationMinutesintegerrequired
weekdaystringrequired
monthlynullablerequired
endsobjectrequired
typestringrequired
countintegerrequired
repeatUntilstringrequired
completedAtnullablerequired
metaobjectrequired
requestIdstringrequired
Example: updates_a_schedule_with_no_past_occurrences_in_place
{
  "object": "recurring_schedule",
  "id": "00000000-0000-4000-8000-000000000001",
  "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "frequency": "weekly",
  "startDate": "2026-06-22",
  "time": "20:00",
  "durationMinutes": 120,
  "weekday": "monday",
  "monthly": null,
  "ends": {
    "type": "after",
    "count": 3
  },
  "repeatUntil": "2026-07-13",
  "completedAt": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: splits_a_schedule_with_past_occurrences,_preserving_history
{
  "object": "recurring_schedule",
  "id": "00000000-0000-4000-8000-00000000000a",
  "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "frequency": "weekly",
  "startDate": "2026-06-06",
  "time": "20:00",
  "durationMinutes": 120,
  "weekday": "saturday",
  "monthly": null,
  "ends": {
    "type": "after",
    "count": 4
  },
  "repeatUntil": "2026-07-04",
  "completedAt": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: applies_the_update_from_the_chosen_occurrence_onward_when_fromoccurrenceid_is_given
{
  "object": "recurring_schedule",
  "id": "00000000-0000-4000-8000-00000000000a",
  "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "frequency": "weekly",
  "startDate": "2026-06-22",
  "time": "20:00",
  "durationMinutes": 120,
  "weekday": "monday",
  "monthly": null,
  "ends": {
    "type": "after",
    "count": 4
  },
  "repeatUntil": "2026-07-20",
  "completedAt": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

403

Updates a schedule in place
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

Updates a schedule in place
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

422

Updates a schedule in place
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstringnullable
messagestring
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "meta": {
    "requestId": "string"
  }
}