Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Events

Update an event

Update an event using either its unique ID or URL-friendly slug

put/events/{key}

Path parameters

keystring required

Event key - either a unique ID (evt_xxx format) or URL-friendly slug

Example:evt_01jps5cgsenjrazw6wswmyspa3

Request body

idstring

A unique identifier for this event

namestring

The title of the event shown to attendees

slugstring

URL-friendly slug for the event. Omit to leave unchanged. Must be unique and between 3 and 100 characters

descriptionstring

Detailed description of the event. Omit to leave unchanged.

visibility'PUBLIC' | 'PRIVATE' | 'SCHEDULED' | 'PASSCODE' | 'CANCELLED'

Who can see the event

currency'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL'

Three-letter ISO 4217 currency code used for ticket prices

urlstring uri nullable

External event URL. Pass null to clear; omit to leave unchanged.

entryStartsAtstring

Wall clock time when event entry begins (no timezone, displays same everywhere)

entryEndsAtstring

Wall clock time when event entry ends (no timezone, displays same everywhere)

publishAtstring

Wall clock time when the event becomes publicly visible (no timezone)

locationRevealAtstring nullable

Deprecated. Use location.sendAt for customer access and location.publishAt for scheduled public address visibility.

entryInstructionsstring nullable

Deprecated. Use location.instructions for customer-facing arrival instructions.

teamIdstring

Team that owns this event. Denormalized for efficient queries.

promoterIdstring

Promoter organizing the event. Must belong to the team.

metadataobject

Flexible key-value metadata storage for custom configuration. Similar to Stripe's metadata API. Maximum 50 keys, key names up to 40 characters, values up to 500 characters.

genresstring[]

Music genres for the event (1-5 genres)

categoriesstring[]

Event characteristics like vibe, venue type, and amenities (up to 10)

featuredboolean

Whether this event is an editorial pick

passcodestring nullable

Passcode for protected access. Pass null to clear; changing visibility away from PASSCODE also clears it.

locationIdstring

ID of an existing location to update to. Either locationId or googlePlaceId can be provided.

googlePlaceIdstring

Google Place ID to update location from. Either locationId or googlePlaceId can be provided.

notifyboolean

Whether attendees should be notified about this event update.

Example request

{
  "id": "evt_01jps5cgsenjrazw6wswmyspa3",
  "name": "Test Event",
  "slug": "test-event",
  "description": "This is only a test...",
  "visibility": "PUBLIC",
  "currency": "AUD",
  "url": "https://example.com/events/summer-festival-2025",
  "entryStartsAt": "2026-08-04T06:13:52",
  "entryEndsAt": "2026-08-05T06:13:52",
  "publishAt": "2026-08-03T06:13:52",
  "images": {
    "mobile": {
      "src": "https://assets.session.services/my-image.jpg",
      "alt": "My Image",
      "width": 1080,
      "height": 1080
    },
    "desktop": {
      "src": "https://assets.session.services/my-image.jpg",
      "alt": "My Image",
      "width": 1080,
      "height": 1080
    }
  },
  "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m",
  "genres": [
    "Tech House",
    "Melodic Techno"
  ],
  "categories": [
    "Day Party",
    "Open Air",
    "Free Entry"
  ],
  "featured": true,
  "locationId": "loc_01jqpjksnsen9vprw95et60t2m",
  "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "notify": true
}

Response

OK

Example response

{
  "event": {
    "id": "evt_01jps5cgsenjrazw6wswmyspa3",
    "createdAt": "2026-08-03T06:13:52.214Z",
    "updatedAt": "2026-08-03T06:13:52.214Z",
    "name": "Test Event",
    "slug": "test-event",
    "description": "This is only a test...",
    "approval": "APPROVED",
    "status": "UPCOMING",
    "visibility": "PUBLIC",
    "currency": "AUD",
    "url": "https://example.com",
    "entryStartsAt": "2026-08-04T06:13:52",
    "entryEndsAt": "2026-08-05T06:13:52",
    "publishAt": "2026-08-03T06:13:52",
    "images": {
      "mobile": {
        "src": "https://assets.session.services/my-image.jpg",
        "alt": "My Image",
        "width": 1080,
        "height": 1080
      },
      "desktop": {
        "src": "https://assets.session.services/my-image.jpg",
        "alt": "My Image",
        "width": 1080,
        "height": 1080
      }
    },
    "geohash": "r3gx1",
    "location": {
      "id": "loc_01hk153x00eh99pagyydz03sbz",
      "googlePlaceId": "ChIJP3Sa8ziYEmsRUKgyFmh9AQM",
      "createdAt": "2026-08-03T06:13:52.214Z",
      "updatedAt": "2026-08-03T06:13:52.214Z",
      "name": "Watson's EQ",
      "address": "The, Entertainment Quarter, 1 Bent St, Moore Park NSW 2021, Australia",
      "city": "Moore Park",
      "state": "New South Wales",
      "postcode": "2021",
      "country": "Australia",
      "latitude": -33.8944593,
      "longitude": 151.2252255,
      "timeZone": "Australia/Sydney",
      "types": [
        "establishment",
        "point_of_interest",
        "stadium"
      ],
      "description": "Historic outdoor amphitheater known for summer concerts",
      "image": {
        "src": "https://assets.session.services/my-image.jpg",
        "alt": "My Image",
        "width": 1080,
        "height": 1080
      },
      "venue": {
        "image": {
          "src": "https://assets.session.services/my-image.jpg",
          "alt": "My Image",
          "width": 1080,
          "height": 1080
        }
      }
    },
    "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m",
    "genres": [
      "Tech House",
      "Melodic Techno"
    ],
    "categories": [
      "Day Party",
      "Open Air",
      "Free Entry"
    ],
    "featured": true,
    "likes": 42
  }
}