Update an event tag

Changes the name, video length and fields of an event tag.

Input. The body of Create an event tag, with _id set to the id of the event tag to change. name, videoLength and fields replace the stored values.

Response. matchedCount is 1 when your organization has an event tag with this _id, and 0 when it has none: nothing changes, and the status is still 200. An event tag of another organization counts as none. modifiedCount is 1 whenever an event tag matched, even when the values sent equal the stored ones: every update stamps updatedAt.

Notes. A missing _id, or one that is not the 24-character id of an event tag, answers 400.

Side effects. Events already posted keep the values they were posted with. Alerts configured on the event tag keep working: they refer to its id, not its name.

Required scope: write:custom-events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Id of the event tag. Omit it when creating: Lumana assigns one. Required when updating.

string
required

Name of the event tag, shown in Lumana where an event tag is picked.

number
required

Length of the video clip shown for each event, in SECONDS, 0 to 60. The clip starts at the event time.

fields
array of objects
required

Fields every event of this event tag carries, each a name and a type (0 text, 1 true/false, 2 number, 3 decimal). At most 100; the Lumana app shows and edits up to 10.

fields*
Responses

400

_id is missing or is not the 24-character id of an event tag, name is missing or empty, videoLength is not a number from 0 to 60, or fields is not an array of at most 100 items.

500

Internal server error.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*