Creating Participants
This step shows the method to add one or more users as participants in a session with Perculus API.
Using Perculus API, there are two ways to create participants for a session:
Adding a user to the session
Before you can add a user as a participant in a session, you will need the USER_ID data of that user and the SESSION_ID data of that specific session.
Available parameters:
user_id
string
Yes
n/a
GUID of the user that will be added to the session as a participant
role
string
No
User's role. See information Hint below
Example Payload:
Example Response:
You will need to work with the 'ATTENDANCE_CODE' data in the example response you see above if you are making an edit to the settings of a participant in that session. You must therefore store this data securely.
To obtain the attendance link for participants to join the session, please see the relevant section.
approved:
Lists the records successfully added from the users.
rejected:
Lists the records that cannot be added from users.
Example Response:
Last updated
Was this helpful?