2. Manage Registrations | Airmeet Public API

Modified on Mon, 15 Apr 2024 at 11:58 AM

TABLE OF CONTENTS

1. Overview
2. Use cases
- Datacenter (region)-wise API endpoints:
3. Authentication
- 3.1 Generate Access token & key
4. Manage Registrations API's
5. Points to keep in mind and Limitations

1. Overview

Connect your Platform stack with Airmeet APIs and create events, add sessions, or add participants for an Airmeet event.

2. Use cases

Adding registrations to an event
Adding speakers in bulk
Creating sessions in bulk
Creating booths in bulk
Fetching attendance for the event, sessions, and booths for an event
Fetching poll responses, questions asked for an event

Datacenter (region)-wise API endpoints:

1. Use the "Default region" API if your community URL looks like this:

Default region (Mumbai): https://api-gateway.airmeet.com/prod

2. Use the "EU region" API if your community URL looks like this:

EU region: https://api-gateway-prod.eu.airmeet.com/prod

3. Use the "US region" API if your community URL looks like this:

US region: https://api-gateway-prod.us.airmeet.com/prod

Community dashboard: https://www.airmeet.com/ (use this to get a key pair issued).

3. Authentication

3.1 Generate Access token & key

Step 1: Sign in to your airmeet account ( https://www.airmeet.com/signup )

Step 2: Click on the "Integrations" tab and select the "API Access Key" section.

Step 3: Click on "Generate access key" and provide a name/label to your key (can be anything that can be remembered later)

Step 4: After providing your label name 'X-Airmeet-Access-Key' with 'X-Airmeet-Secret-Key' would be generated, which can be used in API integration

Access Key = X-Airmeet-Access-Key

Secret Key = X-Airmeet-Secret-Key

All APIs expect a Content-Type: application/JSON header.

3.2 Authentication

POST /auth

This API issues a token for use with the other APIs mentioned in this doc.

Tokens issued by this API are valid for 30 days and can be cached on the consumer service.

Headers

X-Airmeet-Access-Key and X-Airmeet-Secret-Key (can be obtained over from the integrations tab in the community dashboard)

Response

200 OK {"success": true, "data": {"label": "test", "token":

<your_access_token>}}

400 Bad Request - in case the request is missing a header or the supplied values are incorrect

403 Forbidden - in case the keys are revoked (abuse prevention)

500 Internal Server Error - generic server error

4. Manage Registrations

4.1 Add Authorized Attendee

POST /airmeet/{airmeet_id}/attendee

Adds an attendee allowed to enter the Airmeet specified. A 'unique link (Magic Link)' would be sent to users, and after clicking on the link, the user can modify these details at the time of entry to the Airmeet.

The user will be visible in the session with the details provided in this API, but they can use different details in their individual user profiles.

Headers:

X-Airmeet-Access-Token: airmeet_access_token

Request Payload:

{

"email": "user_email@example.com",

"firstName": "John",

"lastName": "Doe",

"attendance_type": "IN-PERSON",

"city": "abc",

"country": "xyz",

"designation": "qwerty",

"organisation": "Airmeet",

"registerAttendee": false,

"sendEmailInvite": true

}

Email address, First & Last name are mandatory fields.

For a Hybrid Conference Format, the attendance type field is mandated, and "attendance_type": "IN-PERSON" or "VIRTUAL." should be mentioned.

IN-PERSON: For attended joining onsite. The attendee will also receive an email containing a QR code and magic link.

VIRTUAL: For attendees joining virtually from their desktop/laptop.

Note :

If registerAttendee is set as false, the attendee will be treated as an invitation and saved in the ‘registration pending’ state until they click on their unique link. The default value for registerAttendee is false. It is an optional parameter.
Set registerAttendee as true if you want to add the attendee as a confirmed registration. Please note that this will increase the number of event registrations for the event and reduce the number of registrations left by 1.
If sendEmailInvite is set to true, an email will be sent to the attendee with the event calendar invite and the unique link. The default value for sendEmailInvite is true. It is an optional parameter.
Set sendEmailInvite to false if you wish to skip sending the email to your attendee.
For the Hybrid Conference format, if the attendance type: is "IN-PERSON" or "VIRTUAL," the participants would be considered registered by default, and the registration limit would be deducted.
Registration Form fields are trimmed to fit the permitted field length on Airmeet. Name, Organisation, Designation, City and Country fields are trimmed to 70 characters. FirstName and LastName fields are trimmed to 35 characters. If the field in API is longer than 70 characters, we add ‘...’ at the end to indicate that the field has been trimmed.

Replaying this request does not change any details for the user. It only authorizes the user again in case their access is revoked.

Response:

200 OK - {"email": "user_email@example.com", "entryLink":

"https://www.airmeet.com/e/<airmeet_id>?code=<unique_entry_code>"}

400 Bad Request - in case the passed token is bad

401 Unauthorized - in case the passed token does not have permission for the passed

airmeet_id

404 Not Found - in case the supplied airmeet_id param is invalid

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

4.2 Add Authorized Attendee with Custom Registration Fields

POST /airmeet/{airmeet_id}/attendee

Adds an attendee allowed to enter the Airmeet specified with custom registration fields. A 'unique link (Magic Link)' would be sent to users, and after clicking on the link, the user can modify these details at the time of entry to the Airmeet.

The user will be visible in the session with the details provided in this API.

Headers:

X-Airmeet-Access-Token: airmeet_access_token

Request Payload:

{

"email": "user_email@example.com",

"firstName": "John",

"lastName": "Doe",

"city": "abc",

"country": "xyz",

"designation": "qwerty",

"organisation": "Airmeet",

"customFieldMapping": [

      {

        "fieldId": "d68ebeb2-bf18-4c96-837b-8872604ae653",

        "value": "Longfield data"

      },

      {

        "fieldId": "dbdf99b1a-ee3b-4dd3-9d97-d54df19f0ba6",

        "value": "option02"

      },

      {

        "fieldId": "af2c99c3-ba9a-4d17-a150-d06a1ae5b736",

        "value": ["Medium","sad","Happy"]

    }],

"registerAttendee": false,

"sendEmailInvite": true

}

Email address, First & Last name are mandatory fields.

For a Hybrid Conference Format, the attendance type field is mandated, and "attendance_type": "IN-PERSON," or "VIRTUAL." should be mentioned.

IN-PERSON: For attended joining onsite. The attendee will also receive an email containing a QR code and magic link.

VIRTUAL: For attendees joining virtually from their desktop/laptop.

Note :

“custom field mapping” takes an array of fields as the value. Use the “Fetch Custom Registration Fields” API to generate the appropriate value.

4.4 Fetch Airmeet Custom Registration Fields

Replaying this request does not change any details for the user. It only authorizes the user again in case their access was revoked.

If registerAttendee is set as false, the attendee will be treated as an invitation and saved in the ‘registration pending’ state until they click on their unique link. The default value for registerAttendee is false. It is an optional parameter.
Set registerAttendee as true if you want to add the attendee as a confirmed registration. Please note that this will increase the number of event registrations for the event and reduce the number of registrations left by 1.
If sendEmailInvite is set to true, an email will be sent to the attendee with the event calendar invite and the unique link. The default value for sendEmailInvite is true. It is an optional parameter.
Set sendEmailInvite to false if you wish to skip sending the email to your attendee.
For the Hybrid Conference format, if the attendance type: is "IN-PERSON" or "VIRTUAL," the participants would be considered registered by default, and the registration limit would be deducted.

Response:

200 OK - {"email": "user_email@example.com", "entryLink":

"https://www.airmeet.com/e/<airmeet_id>?code=<unique_entry_code>"}

400 Bad Request - in case the passed token is bad

401 Unauthorized - in case the passed token does not have permission for the passed

airmeet_id

404 Not Found - in case the supplied airmeet_id param is invalid

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

4.3. Block Attendee

PUT /airmeet/{airmeetId}/attendee/block

Blocks an attendee from the specified Airmeet

Headers:

X-Airmeet-Access-Token: airmeet_access_token

Request Payload:

{

    "attendeeEmail": "user_email@example.com",

}

Here, attendeeEmail is the email of the attendee being blocked from the event.

Response:

200 OK - {"success": true}

400 Bad Request - in case the passed token is bad

401 Unauthorized - in case the passed token does not have permission for the passed

airmeet_id

404 Not Found - in case the supplied airmeet_id param is invalid

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

4.4 Unblock Attendee

PUT /airmeet/{airmeetId}/attendee/unblock

Removes the block on an attendee from the specified Airmeet

Headers:

X-Airmeet-Access-Token: airmeet_access_token

Request Payload:

{

    "attendeeEmail": "user_email@example.com",

}

Here, attendeeEmail is the email of the attendee whose block from the event is being removed.

Response:

200 OK - {"success": true}

400 Bad Request - in case the passed token is bad

401 Unauthorized - in case the passed token does not have permission for the passed

airmeet_id

404 Not Found - in case the supplied airmeet_id param is invalid

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

5. Points to keep in mind and Limitations

A few time zones might not be available. Kindly check the dashboard for available time zones while creating an event.
Email address and First and last name are mandatory fields in uploading the CSV file and the custom registration form.
While fetching the list of Airmeets, The before and after cursors cannot be used simultaneously. If they are both specified, the API ignores them before the cursor.
Tokens issued by this API are valid for 30 days and can be cached on the consumer service.
While creating a session:
- Only SessionTitle, SessionStartTime, and Host Email are mandatory fields.
- Speakers should be added to the Airmeet before creating the session.
- Team members should be added to the community before creating the session.
- If you want a speaker to get the same privilege as a co-host, you can add their email in both the speaker and cohost fields.
- The session type should be HOSTING only.

Need more help? Contact support@airmeet.com or visit our 24*7 Support Lounge.