Calendar Event Types

Tags: configuration, events, scheduling

Calendar event type definitions

Resources

Request and response models used by the endpoints on this page.

CreateEventTypeRequest

Field	Type	Required	Description
active	Boolean		Default: True
bufferAfterMinutes	Integer		Default: 0
bufferBeforeMinutes	Integer		Default: 0
color	String
defaultDurationMinutes	Integer	✓
description	String
eventRules	Array
maxAttendees	Integer
minAttendees	Integer		Default: 1
name	String	✓
slug	String

Example:

{
  "name": "string"  // String,
  "slug": "string"  // String, optional,
  "description": "string"  // String, optional,
  "defaultDurationMinutes": 0  // Integer,
  "bufferBeforeMinutes": 0  // Integer, optional, default: 0,
  "bufferAfterMinutes": 0  // Integer, optional, default: 0,
  "minAttendees": 0  // Integer, optional, default: 1,
  "maxAttendees": 0  // Integer, optional,
  "color": "string"  // String, optional,
  "active": false  // Boolean, optional, default: True,
  "eventRules": []  // Array<EventRuleData>, optional
}

EventTypeResponse

Field	Type	Required	Description
active	Boolean	✓
bufferAfterMinutes	Integer	✓
bufferBeforeMinutes	Integer	✓
color	String	✓
createdAt	DateTime	✓
defaultDurationMinutes	Integer	✓
description	String	✓
id	Integer	✓
maxAttendees	Integer	✓
minAttendees	Integer	✓
name	String	✓
slug	String	✓
templateUuid	String	✓
updatedAt	DateTime	✓
uuid	String	✓

Example:

{
  "id": 0  // Integer,
  "uuid": "string"  // String,
  "templateUuid": "string"  // String,
  "name": "string"  // String,
  "slug": "string"  // String,
  "description": "string"  // String,
  "defaultDurationMinutes": 0  // Integer,
  "bufferBeforeMinutes": 0  // Integer,
  "bufferAfterMinutes": 0  // Integer,
  "minAttendees": 0  // Integer,
  "maxAttendees": 0  // Integer,
  "color": "string"  // String,
  "active": false  // Boolean,
  "createdAt": "2024-01-01T00:00:00Z"  // DateTime,
  "updatedAt": "2024-01-01T00:00:00Z"  // DateTime
}

UpdateEventTypeRequest

Field	Type	Required	Description
active	Boolean
bufferAfterMinutes	Integer
bufferBeforeMinutes	Integer
color	String
defaultDurationMinutes	Integer
description	String
eventRules	Array
maxAttendees	Integer
minAttendees	Integer
name	String
slug	String

Example:

{
  "name": "string"  // String, optional,
  "slug": "string"  // String, optional,
  "description": "string"  // String, optional,
  "defaultDurationMinutes": 0  // Integer, optional,
  "bufferBeforeMinutes": 0  // Integer, optional,
  "bufferAfterMinutes": 0  // Integer, optional,
  "minAttendees": 0  // Integer, optional,
  "maxAttendees": 0  // Integer, optional,
  "color": "string"  // String, optional,
  "active": false  // Boolean, optional,
  "eventRules": []  // Array<EventRuleData>, optional
}

Endpoints

• GET /api/v2/w/{workspace_uuid}/calendar-event-types - List
• POST /api/v2/w/{workspace_uuid}/calendar-event-types - Create
• DELETE /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id} - Delete Event Type Id
• GET /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id} - Get Event Type Id
• PUT /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id} - Update Event Type Id

List

GET /api/v2/w/{workspace_uuid}/calendar-event-types

Description:

List all calendar event types.

Authorization: Requires calendars:read scope

Parameters:

• page (Integer)
• pageSize (Integer)
• active_only (Boolean)

Response: See PaginatedResponse[EventTypeResponse]

---

Create

POST /api/v2/w/{workspace_uuid}/calendar-event-types

Description:

Create a new calendar event type.

Authorization: Requires calendars:write scope

Parameters:

• request - See CreateEventTypeRequest

Response: See EventTypeResponse

---

Delete Event Type Id

DELETE /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Delete a calendar event type.

Note: This will fail if there are existing events using this type. Consider deactivating instead by setting active=false.

Authorization: Requires calendars:admin scope

Parameters:

• event_type_id (Integer)

---

Get Event Type Id

GET /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Get a specific event type by ID.

Authorization: Requires calendars:read scope

Parameters:

• event_type_id (Integer)

Response: See EventTypeResponse

---

Update Event Type Id

PUT /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Update an existing calendar event type.

Authorization: Requires calendars:write scope

Parameters:

• event_type_id (Integer)
• request - See UpdateEventTypeRequest

Response: See EventTypeResponse

---