✍️Creating and Updating Attendees

In order to create and update attendees, the request needs to include a JSON array body that has at least one of the attendee objects. The objects can be of type:

For all attendees in a session, an attendee's email, and user guid(if applicable) has to be unique.

Example Request:

The request below shows the usage of all possible objects:

curl -L -X POST 'https://<DOMAIN>/xapi/v2/session/:SESSION_GUID/attendee/batch' \
--data-raw '
[
     // you can use a user_guid to insert or update, and it will parse all variables of that user to the attendee like email, mobile, and role(sending a role will override)
     // the response for this will show insert
    {
        "user_guid": "44EF7B95-81B0-419D-BB0D-DFBD545F6008"
    },
     // you can use a user_guid to insert or update, and it will parse all variables of that user to the attendee like email, mobile, and role(sending a role will override)
     // the response for this will show update
    {
        "user_guid": "7fd2b7ab-dfbe-4b35-a217-ec11791a4a80",
        "role": "a"
    },
     // a non existing user guid will get rejected
    {
        "user_guid": "7fd2b7ab-dfbe-4b35-a217-ec11791a4a8x"
    },
    // you can insert or update a user with email, name, surname and role(defaults to 'u' if not present)
    // this is the correct format to use when adding external attendees (meaning they are not registered as a user)
    // response will show insert
    {
        "email": "[email protected]",
        "name": "John",
        "surname": "Doe",
        "role": "e"
    },
    // you can insert or update a user with email, name, surname and role(defaults to 'u' if not present)
    // response will show update
    {
        "email": "[email protected]",
        "name": "updated_name",
        "surname": "Doe",
        "role": "u"
    },
    // you can update an existing attendee with its attendance_code
    {
        "attendance_code": "5786FF4C-4A93-45A2-BAF1-9461F376E8C5",
        "role": "e"
    },
    // non existent attendance_code will get rejected
    {
        "attendance_code": "2BA64ED7-EE65-4164-A0A0-85A45E8D0BFx",
        "mobile": "+00 000 00 00"
    }
]
'

Example Response:

The response for this operation includes a json object like so:

Response Status Codes will vary depending on how the operations went:

  • 200 OK: All operations completed successfully

  • 207 Multi-Status: Partial success - some operations failed

  • 400 Bad Request: All operations failed

Last updated

Was this helpful?