Docs

Add Event

POST /Organizations/{orgId}/events

POST/Organizations/{orgId}/events

Creates an event in the organization and returns its id. Set Status to Draft to save a draft that only holds the data sent; it is turned into a real event later with Organizations_SetEventStatus. Otherwise the event is created and activated at once. With a templateId the template builds the event's structure (collaborators, areas, activities, tasks, advances and more), using the values in templateInputs; without one, the caller becomes event admin and a default collaborator named defaultCollaboratorName is created. When the event type has an intake form, answers seed it. Needs Organization basic access, and a user caller also needs a BackOps Pro seat in the organization (API keys need none). Type, template and attribute ids come from the Organization API's EventTypes_GetEventTypes and EventTypes_GetEventAttributes, and Templates_GetTemplates.

Path Parameters

FieldTypeRequiredDescription
orgIduuidRequired

Request Body

FieldTypeRequiredDescription
namestringOptional
eventTypeIduuidOptional
statusstringOptional
defaultCollaboratorNamestringOptional
templateIduuidOptional
userIduuidOptional
templateInputsobjectOptional
attributesAddEventRequestAttribute[]Optional
answersAddEventRequestAnswer[]Optional

AddEventRequestAttribute

FieldTypeDescription
attributeIduuid
valuestring| null

AddEventRequestAnswer

FieldTypeDescription
questionIduuid
valuestring| null

Response

FieldTypeDescription
eventIduuid