Docs home

Module Create Update

Turns the Events module on or off for your organization. Call it once before creating events: creating an event fails until this setting exists for the organization.

POST/event/module/settings
Module Create Update
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/event/module/settings' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"module_name":"Events 1","module_description":"McGrawHill Annual Events adsdas","landing_page_url":"https://www.google.com","is_active":1}'
{
  "code": 200,
  "message": "Event module updated successfully !"
}

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

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
is_activeintegerrequired
1 turns Events on, 0 turns it off.
Response200application/json
codeinteger
Example: 200
messagestring
"Event module updated successfully !"
Example: Event module updated successfully !

Notes: The setting applies to the organization in your ORGID header when that organization has its own domain; otherwise it applies to the whole institute. Turning the module on or off also shows or hides Events in the learner menu. Any value other than 0 or 1 returns "Invalid is_active status.". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI