Skip to content

Update Event

PATCH/events/:id

Update an existing event. Only the attributes you include are changed.

Attributes

AttributeTypeDescription
namestring
startDatestring
endDatestring
statusstring
signupTypestring
signupStartAtstring
signupEndAtstring
rsvpLimitstring
emailstring
websitestring
timeZonestring
continuousstring
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.
hasAdvancedColorsstringWhen 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").
buttonBorderRadiusstringButton 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
ticketsPerPurchasestring
locationNamestring
locationPlacestringLocation/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.
workspaceIdstring

Fields marked with * are required.

Request

js
import Confetti from 'confetti'

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

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