Guests

Adding a guest participant will deprive you from some functionalities as opposed to adding an existing user to a session as a participant.

External participants are attendees of a session that doesn't belong to an account. Below, you can see the parameters which you can send:

Parameter

Type

Required

Default

Description

name

string

Yes

n/a

Name of the participant

surname

string

Yes

n/a

Surname of the participant

string

Yes

n/a

Email address of the participant

mobile

string

null

Mobile of the participant

role

string

email parameter is a unique constraint for a session, therefore, if there exists a participant with that email, the call will update the existing participant.

Example Payload:

curl --location --request POST \
'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendees' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '[
    {
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@example.com",
        "role" "a"
    }
]'

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Add a Guest Attendee
attendee = client.attendees.add_attendee("<SESSION_ID>", {
    "name": "John",
    "surname": "Doe",
    "email": "john.doe@example.com",
    "role" "a"
})
print(attendee)

# Add Multiple Guest Attendees
attendees = client.attendees.add_multiple("<SESSION_ID>", [
    {
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@example.com"
    },
    {
        "name": "John",
        "surname": "Doe2",
        "email": "john.doe2@example.com",
        "role" "a"
    }
])
print(attendees)

// ASAP :)

import APIClient from "perculus-sdk"

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

// Add an attendee
const attendee = client.attendees.addAttendee("<SESSION_ID>", "<USER_ID>")
console.log(attendee)

// Add Multiple Attendees
const attendees = client.attendees.addMultipleAttendees("<SESSION_ID>", [
    {
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@example.com",
        "role" "a"
    }
])
console.log(attendees)

// ASAP :)

Creating an external participant

PreviousCreating Participants NextAttendance Link

Last updated 4 months ago

Was this helpful?

curl --location --request POST \ 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendees' \ --header 'Authorization: Bearer <ACCESS_TOKEN>' \ --header 'Content-Type: application/json' \ --data '[ { "name": "John", "surname": "Doe", "email": "john.doe@example.com", "role" "a" } ]'

from perculus_sdk.client import APIClient # API client client = APIClient() ... # Add a Guest Attendee attendee = client.attendees.add_attendee("<SESSION_ID>", { "name": "John", "surname": "Doe", "email": "john.doe@example.com", "role" "a" }) print(attendee) # Add Multiple Guest Attendees attendees = client.attendees.add_multiple("<SESSION_ID>", [ { "name": "John", "surname": "Doe", "email": "john.doe@example.com" }, { "name": "John", "surname": "Doe2", "email": "john.doe2@example.com", "role" "a" } ]) print(attendees)

import APIClient from "perculus-sdk" // API client const client = new APIClient() ... // Add an attendee const attendee = client.attendees.addAttendee("<SESSION_ID>", "<USER_ID>") console.log(attendee) // Add Multiple Attendees const attendees = client.attendees.addMultipleAttendees("<SESSION_ID>", [ { "name": "John", "surname": "Doe", "email": "john.doe@example.com", "role" "a" } ]) console.log(attendees)