Docs home

Event Registration

Registers the logged-in learner for an event. For a free event (or one included in the learner's subscription) the registration is confirmed at once. For a paid event it starts a payment and returns what you need to open the payment gateway checkout.

POST/event/registration/{event_id}
Event Registration
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/event/registration/{event_id}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"payment_gateway":8,"amount_paid":999,"organization_id":2}'

Access: Learners (for themselves). Admins and custom roles with events permission can also call it, but it always registers the calling user.

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

Path parameters
event_idintegerrequired
The event ID, as the last URL segment.
BodyJSONString
Organization that runs the event. Defaults to your current organization.
Accepted but ignored. The price is always calculated by the server.
Accepted but ignored. The gateway is chosen from the organization's settings.

Response: event with event_registration_id, event_payment_id, payment_gateway_used (gateway ID) and, for paid events, the checkout details for that gateway (for example the gateway order ID and key) to start payment on the client.

Notes: Only published, not cancelled, not archived events that have not started yet can be booked; otherwise "Invalid Event Id" or "You can only register in upcoming events.". Registering twice returns "User already registered for the event !"; a second request while the first is still processing returns "A registration for this event is already being processed. Please try again.". The price includes GST when your institute charges GST on top (INR only). If the learner is not yet a member of the organization, they are added as a student. Paid registrations stay "payment in progress" until the gateway confirms payment; an invoice is created at once. Free registrations trigger the registration confirmation notifications. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI