❌Removing Participants

This step shows how to remove participants from a session via GroupsAPI

Important Note! Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward. Link to V2 API documentation: https://developer.perculus.com/v2-en

There are three ways to remove a participant from a session:

ATTENDANCE_CODE
USER_ID
EMAIL

Examples:

With ATTENDANCE_CODE parameter

curl --location --request DELETE 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<ATTENDANCE_CODE>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

With USER_ID parameter

curl --location --request DELETE 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<USER_ID>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

With EMAIL parameter

curl --location --request DELETE 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Delete the attandee by ATTENDANCE_CODE
client.attendees.delete_by_attendance_code_or_user_id(
    session_id="<SESSION_ID>",
    attendance_code_or_user_id="<ATTENDANCE_CODE>"
)

# Delete the attandee by USER_ID
client.attendees.delete_by_attendance_code_or_user_id(
    session_id="<SESSION_ID>",
    attendance_code_or_user_id="<USER_ID>"
)

# Delete the attandee by EMAIL
client.attendees.delete_by_email(
    session_id="<SESSION_ID>",
    email="<EMAIL>"
)

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Delete the attandee by ATTENDANCE_CODE
client.attendees.deleteAttendee("<SESSION_ID>", "<ATTENDANCE_CODE>")

// Delete the attandee by USER_ID
client.attendees.deleteAttendee("<SESSION_ID>", "<USER_ID>")

// Delete the attandee by EMAIL
client.attendees.deleteAttendee("<SESSION_ID>", "<EMAIL>")

PreviousUpdating Participants NextFiltering Participants

Last updated 4 months ago