Skip to main content

This page is also available as plain markdown · OpenAPI spec

Create recurring schedule

POST 

/events/:eventId/recurring_schedules

Create recurring schedule

Request

Path Parameters

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

Body

frequencystringrequired
startDatestringrequired
timestringrequired
durationMinutesintegerrequired
weekdaysstring[]
endsobjectrequired
typestringrequired
countinteger
datestring
monthlyobject
typestringrequired
Example (auto)
{
  "frequency": "string",
  "startDate": "string",
  "time": "string",
  "durationMinutes": 0,
  "weekdays": [
    "string"
  ],
  "ends": {
    "type": "string",
    "count": 0,
    "date": "string"
  },
  "monthly": {
    "type": "string"
  }
}

201

Creates a weekly schedule
dataobject[]required
objectstring
idstring
eventIdstring
frequencystring
startDatestring
timestring
durationMinutesinteger
weekdaystringnullable
monthlyobjectnullable
typestringrequired
dayOfMonthinteger
weekdaystring
occurrenceinteger
endsobject
typestringrequired
countinteger
datestring
repeatUntilstring
completedAtnullable
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: creates_a_weekly_schedule_and_materializes_its_occurrences
{
  "data": [
    {
      "object": "recurring_schedule",
      "id": "00000000-0000-4000-8000-000000000005",
      "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
      "frequency": "weekly",
      "startDate": "2026-06-22",
      "time": "19:00",
      "durationMinutes": 90,
      "weekday": "monday",
      "monthly": null,
      "ends": {
        "type": "after",
        "count": 4
      },
      "repeatUntil": "2026-07-20",
      "completedAt": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 1,
  "totalCount": 1,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: fans_a_multi-weekday_request_out_to_multiple_schedules
{
  "data": [
    {
      "object": "recurring_schedule",
      "id": "00000000-0000-4000-8000-000000000005",
      "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
      "frequency": "weekly",
      "startDate": "2026-06-24",
      "time": "19:00",
      "durationMinutes": 90,
      "weekday": "wednesday",
      "monthly": null,
      "ends": {
        "type": "after",
        "count": 3
      },
      "repeatUntil": "2026-08-03",
      "completedAt": null
    },
    {
      "object": "recurring_schedule",
      "id": "00000000-0000-4000-8000-000000000006",
      "eventId": "062a5e0a-bbea-4836-bfda-12407804b88f",
      "frequency": "weekly",
      "startDate": "2026-06-22",
      "time": "19:00",
      "durationMinutes": 90,
      "weekday": "monday",
      "monthly": null,
      "ends": {
        "type": "after",
        "count": 3
      },
      "repeatUntil": "2026-08-03",
      "completedAt": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 2,
  "totalCount": 2,
  "hasNextPage": false,
  "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 a weekly schedule
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

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

422

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