Skip to navigation

Update Event

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

eventIdstringRequired

Request

This endpoint expects an object.
titlestringOptional
descriptionstringOptional
codestringOptional
passcodestringOptional
statusenumOptional

Returned as the doors have it (see EventPhase): DRAFT for an event waiting for a host, LIVE for one scheduled or open, ENDED for one that is over, even in the few minutes before it is marked so and its overage settled. The times open and close an event by themselves, so a host sets a status only to start one with no time to open at (LIVE), to end one early (ENDED), or to reopen one (LIVE). Reopening an event whose last window has closed clears its endsAt and questionsCloseAt; setting ENDED settles the overage.

Allowed values:
audienceenumOptional

Defaults to PUBLIC on create; left alone on update.

Allowed values:
allowedDomainslist of stringsOptional

Replaces the domains a DOMAIN event lets in, at most 20; @ and whole addresses are trimmed to their domain. Each must be on the workspace’s allow-list, or already be one of the event’s: otherwise 422 domain_not_allowed, with the domains in details.domains. Empty means the whole allow-list, including domains added to it later; listing every domain on it instead fixes the choice to those. Left out on update, the list is left alone.

requireGooglebooleanOptional

For a DOMAIN event: take Google sign-in only, and send no codes. False on create; left alone on update. Stored as sent, but a workspace that requires Google sign-in makes every event Google only whatever this says.

startsAtstringOptional
endsAtstringOptional
questionsOpenAtstringOptional
questionsCloseAtstringOptional
timeZonestringOptional

An IANA zone this server knows (a 422 otherwise), or null for none.

instructionsstringOptional
meetingUrlstringOptional

The Zoom, Google Meet or Microsoft Teams call the event runs beside, as an https join link. For example: a Zoom meeting, webinar or personal room (zoom.us/j/…, /w/…, /my/…, on zoom.us, zoom.com or zoomgov.com and their regional hosts such as us02web.zoom.us); a Meet code (meet.google.com/abc-defg-hij); or a Teams meeting (teams.microsoft.com/l/meetup-join/… or /meet/…, on teams.microsoft.com, teams.live.com, teams.cloud.microsoft or the government clouds). A link still wrapped in Outlook’s Safe Links is unwrapped. Anything else, or a Zoom start link (/s/…), is refused (422). Empty or null clears it.

allowAnonymousbooleanOptional
moderationEnabledbooleanOptional
allowUpvotesbooleanOptional
allowRepliesbooleanOptional
profanityFilterbooleanOptional
showPoweredBybooleanOptional

Whether “Powered by taktoria.com” shows on the event’s way in: the door and the join form. True on create; left alone on update.

presenterControlsbooleanOptional
Whether the presenter screen can spotlight a question, mark it answered and move on.
presentSubtitlestringOptional
A line under the title on the presenter screen. Empty or null clears it.
presentShowTimingbooleanOptional
Whether the presenter screen shows when the event starts and ends.
presentBackgroundstringOptional

Presenter screen background, #rrggbb (or #rgb).

presentAccentstringOptional

Presenter screen accent, #rrggbb (or #rgb).

Response

This endpoint returns an object.
idstring
organizationIdstring
titlestring
codestring
The short code the room types. Unique inside the workspace rather than globally, so two workspaces can each hold the memorable one their host wants.
statusenum

Returned as the doors have it (see EventPhase): DRAFT for an event waiting for a host, LIVE for one scheduled or open, ENDED for one that is over, even in the few minutes before it is marked so and its overage settled. The times open and close an event by themselves, so a host sets a status only to start one with no time to open at (LIVE), to end one early (ENDED), or to reopen one (LIVE). Reopening an event whose last window has closed clears its endsAt and questionsCloseAt; setting ENDED settles the overage.

Allowed values:
phaseenum

Where the event stands right now, from its times first: it opens at the earlier of startsAt and questionsOpenAt, and ends at the later of endsAt and questionsCloseAt, with nobody having to start it.

Allowed values:
audienceenum

Who may join. Separate from settings, which describes how the room behaves once somebody is in it rather than whether they get in.

Allowed values:
allowedDomainslist of strings

The email domains a DOMAIN event chose from the workspace’s allow-list, such as acme.com. Only those still on it count; empty means the whole allow-list (see /partner-domains).

requireGoogleboolean

For a DOMAIN event: an address counts only when proved by signing in with Google, never by an emailed code. The rule as it applies: true whenever the workspace requires Google sign-in, whatever was set on the event.

hasPasscodeboolean

Whether attendees must type a passcode as well as the code. The passcode itself is never returned; set it with passcode.

settingsobject
createdAtdatetime
updatedAtdatetime
descriptionstringOptional
startsAtdatetimeOptional

When the event starts: it opens by itself then (or at questionsOpenAt, if that is earlier), and is scheduled until it does. With neither, it waits for a host to start it.

endsAtdatetimeOptional

When the event ends, unless questionsCloseAt is later: from the later of the two it is ended, and within five minutes it is marked ENDED and its overage settled, as ending it by hand does.

questionsOpenAtdatetimeOptional
When questions may be asked, if that is not simply "while live".
questionsCloseAtdatetimeOptional

When questions stop. If it is after endsAt, the event stays open until then; before it, the event runs on to its end with no new questions.

timeZonestringOptional

IANA zone the event’s times are written in and shown in, such as Europe/Berlin. Absent for none, where the app shows the times in the workspace’s default zone, else UTC. The times themselves are absolute either way.

instructionsstringOptional
meetingUrlstringOptional

The Zoom, Google Meet or Microsoft Teams call the event runs beside, as its join link. Shown to hosts and to the attendees the event lets in; Dory’s app inside that meeting opens this event.

capacityAtEventintegerOptional

What the workspace was paying for per event when this one was settled. Absent until then: it is copied onto the event so that raising the plan later cannot rewrite an invoice already sent.

overageParticipantsintegerOptional
questionCountintegerOptional
participantCountintegerOptional
hostobjectOptional
A person in a Taktoria organization.
archivedAtdatetimeOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error