Skip to main content

This page is also available as plain markdown · OpenAPI spec

Update occurrence

PATCH 

/events/:eventId/occurrences/:id

Update occurrence

Request

Path Parameters

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

Body

startsAtstringrequired
Example (auto)
{
  "startsAt": "string"
}

200

Updates only the sent field
objectstringrequired
idstringrequired
eventIdstringrequired
startsAtstringrequired
endsAtstringrequired
canceledbooleanrequired
createdAtstringrequired
updatedAtstringrequired
recurringScheduleIdnullablerequired
metaobjectrequired
requestIdstringrequired
Example: updates_only_the_sent_field_and_preserves_the_other_at_the_same_absolute_instant
{
  "object": "occurrence",
  "id": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "startsAt": "2025-06-11T15:00:00-04:00",
  "endsAt": "2025-06-11T16:00:00-04:00",
  "canceled": false,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "recurringScheduleId": 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 only the sent field
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

Updates only the sent field
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

422

Returns 422 when the resulting times are invalid
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstring
messagestring
metaobjectrequired
requestIdstringrequired
Example: returns_422_when_the_resulting_times_are_invalid
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "endsAt",
      "message": "must be after startsAt"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}