Create occurrence

POST 
/events/:eventId/occurrences

Create occurrence

Request

Path Parameters

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

Body

startsAtstringrequired

endsAtstringrequired

Example (auto)

{
  "startsAt": "string",
  "endsAt": "string"
}

201

Creates an occurrence

objectstringrequired

idstringrequired

eventIdstringrequired

startsAtstringrequired

endsAtstringrequired

canceledbooleanrequired

createdAtstringrequired

updatedAtstringrequired

recurringScheduleIdnullablerequired

metaobjectrequired

requestIdstringrequired

Example: creates_an_occurrence

{
  "object": "occurrence",
  "id": "00000000-0000-4000-8000-000000000005",
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "startsAt": "2027-01-15T14:00:00-05:00",
  "endsAt": "2027-01-15T16:00:00-05: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

Creates an occurrence

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example (auto)

{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

Returns 422 when endsAt is not after startsAt

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example (auto)

{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

422

Returns 422 when endsAt is not after startsAt

objectstringrequired

statusintegerrequired

messagestringrequired

errorsobject[]required

messagestring

fieldstring

metaobjectrequired

requestIdstringrequired

Example: returns_422_when_the_parent_event_is_canceled

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Event is canceled; no new occurrences can be added"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: returns_422_when_endsat_is_not_after_startsat

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "endsAt",
      "message": "must be after startsAt"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}