✒️Updating Participants

This step shows how to update participants in a Groups session.

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 two ways to update participant details for a session:

With ATTENDANCE_CODE

You need the SESSION_ID of the session and the ATTENDANCE_CODE, which is the participant ID of the user, to update the participant in a session.

Available parameters:

Parameters

Type

Description

name

string

Name of the participant

surname

string

Surname of the participant

string

Email of the participant

role

string

Role of the user(see for possible values)

mobile

string

Mobile phone of the participant

Example Payload:

curl --location --request PUT 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<ATTENDANCE_CODE>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test",
    "surname": "surname"
    "role": "u"
}'

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Update an Attendee by ATTENDANCE_CODE
attendee = client.attendees.update_by_attendance_code(
    session_id="<SESSION_ID>",
    attendance_code="<ATTENDANCE_CODE>",
    attendee={
        "name": "<NAME>",
        "surname": "<SURNAME>"
        "role": "<ROLE>"
    }
)
print(attendee)

import APIClient from "perculus-sdk"

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

// Update Attendee
const attendee = client.attendees.updateAttendee(
    "<SESSION_ID>", "<ATTENDANCE_CODE>",
    {
        name: "test",
        surname: "surname"
        role: "u"   
    }    
)
console.log(attendee)

With EMAIL

You need the SESSION_ID of the session and the EMAIL, which is the email of the user, to update the participant in a session.

Available parameters:

Parameters

Type

Description

name

string

Name of the participant

surname

string

Surname of the participant

string

Email of the participant

role

string

Role of the user(see for possible values)

mobile

string

Mobile phone of the participant

Example payload:

curl --location --request PUT 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test",
    "surname": "surname"
    "role": "u"
}'

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Update an Attendee by EMAIL
attendee = client.attendees.update_by_email(
    session_id="<SESSION_ID>",
    email="<EMAIL>",
    attendee={
        "name": "<NAME>",
        "surname": "<SURNAME>"
        "role": "<ROLE>"
    }
)
print(attendee)

import APIClient from "perculus-sdk"

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

// Update Attendee
const attendee = client.attendees.updateAttendee(
    "<SESSION_ID>", "<EMAIL>",
    {
        name: "test",
        surname: "surname"
        role: "u"   
    }    
)
console.log(attendee)

PreviousAttendance Link NextRemoving Participants

Last updated 4 months ago

hashtagWith ATTENDANCE_CODE

hashtagWith EMAIL

With ATTENDANCE_CODE

With EMAIL