---
title: "PUT /events"
method: PUT
path: "/events"
tags: ["events"]
---

# PUT /events

`PUT /events`

Create a new Event in a Heartbeat community

## Request body

- object
  - `name` string, required
  - `description` string
  - `startTime` string, date-time, required
  - `duration` number, required
  - `location` string, required — Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field.
  - `invitedUsers` string[] — A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both invitedUsers & invitedGroups are empty, the event will be open to everyone in the community.
  - `invitedGroups` string[] — A list of groups that should be invited to the event. If both invitedUsers & invitedGroups are empty, the event will be open to everyone in the community.

## Response `200`

Successful response

## Other responses

- `400` — Invalid request body
- `401` — API Key is missing or invalid

---

[API](https://skmtc.dev/heartbeat/apis/heartbeat-api.md) · [All operations](https://skmtc.dev/heartbeat/apis/heartbeat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/heartbeat/heartbeat-api/revisions/6c3cf537d508/schema)