Playground

Playground

Event

/api/v1/marketing/events

A marketing event (webinar, conference, meetup, etc.).

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
name*stringEvent name.
typeenumwebinar | conference | meetup | workshop | trade_show | otherEvent type.
statusenumplanning | active | completed | cancelledEvent lifecycle status.
start_datedate-timeISO 8601 event start date/time.
end_datedate-timeISO 8601 event end date/time.
locationstringEvent location (or 'Virtual').
capacitynumberMaximum attendee capacity.
registerednumberNumber of registered attendees.
campaign_idstringAssociated campaign ID.
organizer_idstringUser ID of the organizer.

API

Loading manifest…