Skip to content

Create Event

POST/events

Create a new event.

Attributes

AttributeTypeDescription
name *string
startDate *string
endDatestring
statusenumdraft, open, cancelled. Event lifecycle status. 'draft' = unpublished/private, 'open' = published and live, 'cancelled' = cancelled. To publish a draft event, set status to 'open'; to unpublish, set it back to 'draft'. Publishing requires the event owner's account to be verified.
signupTypeenumrsvp, tickets
signupStartAtstring
signupEndAtstring
privacyVisibilityenumeveryone, invite, password. Who can view the event page. 'everyone' = public, 'invite' = only invited guests with a valid invite, 'password' = requires the event password.
privacyAttendabilityenumeveryone, invite, password. Who can register / RSVP for the event. 'everyone' = anyone, 'invite' = requires a valid invite, 'password' = requires the event password.
privacyPasswordstringPassword required to view/attend when privacyVisibility or privacyAttendability is 'password'.
rsvpLimitnumber
emailstring
timeZonestring
continuousboolean
slugstring
primaryColorstringMain brand color (hex). Used for buttons, links, and accent elements. Must contrast against contrastColor (background).
contrastColorstringBackground color (hex). Used for page backgrounds and button text. Must contrast against primaryColor.
signupColorstringCTA/button color used on signup and payment forms (hex). Must contrast against white (#FFFFFF). Defaults to primaryColor.
textColorstringDefault body text color (hex). Must contrast against contrastColor (background).
secondaryContrastColorstringSecondary background color (hex). Used for alternate sections. Must contrast against primaryColor.
hasAdvancedColorsbooleanWhen false, only primaryColor is used and other colors are auto-derived. When true, all colors are set independently.
fontNormalstringGoogle Fonts font family for body text (e.g. "Inter").
fontNormalCategorystringCSS font category: sans-serif, serif, or monospace.
fontNormalVariantstringFont variant/weight (e.g. "400", "600").
fontHeadingstringGoogle Fonts font family for headings (e.g. "Playfair Display").
fontHeadingCategorystringCSS font category: sans-serif, serif, or monospace.
fontHeadingVariantstringFont weight and style (e.g. "700", "600italic").
buttonBorderRadiusnumberButton corner radius in pixels (e.g. 4 for square, 35 for rounded).
customCssstringGlobal CSS stylesheet applied to every page of the event. Use this to override default styles, customize layouts, hide elements, or add any custom styling. The CSS is injected into a <style> tag on all event pages. Combine with custom HTML blocks for full visual control.
shareTitlestring
shareDescriptionstring
summarystring
smsSenderNamestring
ticketsPerPurchasenumber
locationNamestring
locationPlaceobjectLocation/venue details. Both formatted_address and geometry.location (lat/lng) are needed for the map to render. Without coordinates the map image will be broken.
workspaceIdnumber

Fields marked with * are required.

Request

js
import Confetti from 'confetti'

const confetti = new Confetti({ apiKey: 'your-key' })

const event = await confetti.events.create({
  name: 'example',
  startDate: 'example',
  email: 'jane@example.com',
})
sh
curl -X POST "https://api.confetti.events/events" \
  -H "Content-Type: application/json" \
  -H "Authorization: apikey your-key" \
  -d '{
  "data": {
    "type": "event",
    "attributes": {
      "name": "example",
      "startDate": "example",
      "email": "jane@example.com"
    }
  }
}'