Event Settings API

Read and update the event's own settings, including track and tier names.

Read and change the event’s own settings. All endpoints require the standard authentication headers. /updateEvent requires the event:write scope; /getEvent requires event:read.

Set your tracks and tiers first

A session’s track and a sponsor’s tier are numeric positions in the event’s trackArray and tierArray, not names. Until a track exists, you cannot assign a session to it - the write is rejected as out of range.

So an import normally starts here:

curl -X POST "https://api.event-vault.com/updateEvent" \
  -H "x-api-key: $EV_API_KEY" \
  -H "x-client-id: $EV_CLIENT_ID" \
  -H "x-event-id: $EV_EVENT_ID" \
  -H "x-timestamp: $(python3 -c 'import time;print(int(time.time()*1000))')" \
  -H "Content-Type: application/json" \
  -d '{"trackArray": ["Main Stage", "Workshops", "Community"]}'

After that, "track": 1 on a session means Workshops.

You can name up to 10 tracks and 10 tiers. Send just the ones you use; the rest are left blank for you.

Shortening a list is allowed but warns you, because any session or sponsor still pointing at a name you removed will show up under a blank heading.

GET /getEvent

Returns the event’s settings. Requires event:read.

Credentials, billing figures, banned-user lists, email templates and app menu structure are excluded from the response.

POST /updateEvent

Updates the supplied fields; omitted fields are left unchanged. Requires event:write.

Field	Type	Notes
`name`	string	Event name.
`welcomeText`	rich text	Plain text or Delta JSON.
`dateStart`, `dateEnd`	date	`YYYY-MM-DD`. `dateEnd` must not precede `dateStart`.
`location`	string	Venue name.
`address`, `city`, `state`, `postalCode`, `country`	string
`supportEmail`	email	Shown to attendees for help.
`imagePath`, `mapImagePath`	url	Banner and venue map.
`timeZoneOffset`	integer	Hours from UTC, -12 to 14.
`carouselInterval`	integer	Seconds between sponsor slides, 1 to 60.
`scheduleTimeDisplay`	boolean	Show times on the schedule.
`trackArray`, `tierArray`	array of strings	Names, max 10. See above.
`primaryBackgroundColor`, `secondaryBackgroundColor`, `tertiaryBackgroundColor`, `primaryAccentColor`, `secondaryAccentColor`, `primaryFontColor`, `secondaryFontColor`, `cardBackgroundColor`	color	ARGB integer or `"#RRGGBB"`.

Settings this API will not change

An event has far more settings than the ones above, but most are not things an integration should be able to touch. Sending one of these is rejected with a message explaining why, rather than quietly ignored:

Who the event belongs to - changing this would lock every attendee out of their own event.
Your plan’s limits - attendee capacity and seat counts are set by Event Vault, not by an integration.
Going live - activating an event, publishing it, or changing its access code.
Blocking individual attendees.
Anything Event Vault keeps up to date for you - the guest count, your tag lists, the published-data link.
Keys and connected services - your API key and Salesforce link.
Track colours - the API names your tracks; you pick their colours in the console.

All of those stay console actions, where there is a human looking at the screen.

← Gamification Bulk Import →