For the complete documentation index, see llms.txt. This page is also available as Markdown.

Deleting an Attendee

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

There are three ways to remove an attendee from a session:

With ATTENDANCE_CODE parameter

curl --location --request DELETE 'https://<DOMAIN>/api/groups/xapi/session/<SESSION_GUID>/attendee/<ATTENDANCE_CODE>' \
--header 'Content-Type: application/json'

With USER_GUID parameter

curl --location --request DELETE 'https://<DOMAIN>/api/groups/xapi/session/<SESSION_GUID>/attendee/<USER_GUID>' \
--header 'Content-Type: application/json'

With EMAIL parameter

curl --location --request DELETE 'https://<DOMAIN>/api/groups/xapi/session/<SESSION_GUID>/attendee/<EMAIL>' \
--header 'Content-Type: application/json'

With ATTENDANCE_CODE parameter

client.attendees.delete_by_attendance_code("<SESSION_GUID>", "<ATTENDANCE_CODE>");

With USER_GUID parameter

client.attendees.delete_by_user_id("<SESSION_GUID>", "<USER_GUID>");

With EMAIL parameter

client.attendees.delete_by_email("<SESSION_GUID>", "<USER_EMAIL>");

Example Response:

A successful delete operation will return 204 No Content without any body.

Last updated