Docs home

Create Event

Creates an event (a workshop, webinar or meetup with one or more sessions), with its banner, schedule, host and prices. Learners can then find and register for it.

POST/organization/event
Create Event
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/organization/event' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={
  "title": "JAVA Market Wo2rkshop2",
  "description": "<p>Stock Market Workshoppp Description asdsdasdadsa</p>",
  "event_mode": 1,
  "meeting_platform": 5,
  "meeting_location": "",
  "event_manager": 1,
  "event_schedule": [
    {
      "session_start_time": 1760778076,
      "session_end_time": 1760788876
    },
 {
      "session_start_time": 1760778076,
      "session_end_time": 1760788876
    }
  ],
  "is_published": 1,
  "event_feedback_form_id": "sad",
  "stream_ids": [],
  "subscription_plan_ids": [],
  "pricings": [
    {
      "currency_id": "1",
      "amount": 1099,
      "striked_amount": 20999
    }
  ]
}
' \
  --form 'event_image='

Access: Institute admins, plus custom roles that can manage events.

Request body: form-data with two fields: event_image (the banner image file, required, up to 5 MB, JPEG/PNG/GIF/WebP/AVIF) and JSONString, containing this JSON:

BodyJSONString
titlestringrequired
Event name.
descriptionstringrequired
HTML description. External images are copied into Edmingle.
event_modeintegerrequired
1 Online, 2 Offline.
For online events: 1 Zoom Meeting, 2 BotSite, 3 GoTo, 4 GoTo Meeting, 5 Zoom Webinar, 6 Custom link, 7 Super Live, 8 MS Teams.
Venue, for offline events.
1 turns on the Zoom waiting room. Default 0.
event_managerintegerrequired
User ID of the host. Must be an active member of your organization.
event_schedulearrayrequired
One object per session (fields below).
is_publishedintegerrequired
1 published (visible to learners), 0 draft.
ID of a feedback form to attach.
stream_idsarray of integersrequired
Category IDs. Send [] for none. Each must be an active category of your institute.
subscription_plan_idsarray of integersrequired
Subscription plans that include the event for free. Send [] for none. Each must belong to your organization.
pricingsarrayrequired
One price per currency (fields below). Must include your organization's base currency.
1 lets people join sessions without logging in. Default 0.

Fields in each event_schedule object:

Name Required Type Description
session_start_time Yes Unix timestamp Session start. Must not be in the past.
session_end_time Yes Unix timestamp Session end. Must be after the start.

Fields in each pricings object:

Name Required Type Description
currency_id Yes integer One of your organization's currencies.
amount No number Price. Default 0 (free).
striked_amount No number Crossed-out "was" price. Default 0.

Response: event.event_id, the ID of the new event.

Notes: The event is created in the organization in your ORGID header. Session dates and times are worked out in your user's time zone. Common errors: "Please set event module for respective branch first." (turn the module on with "Module Create Update"), "Please provide banner image.", "Invalid event schedule provided.", "Schedule cannot be in the past.", "Invalid event manager provided.", "One or more invalid stream ids provided.", "One or more invalid subscription plan ids provided.", "Please provide base currency pricing.", "One or more invalid currency id provided.". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI